<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: net_flow/peer_socket.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_460afd45d0ec637b1427e0e06a6fbcf7.html">net_flow</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">peer_socket.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="peer__socket_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="net__flow__fwd_8hpp.html">flow/net_flow/net_flow_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="detail_2net__flow__fwd_8hpp.html">flow/net_flow/detail/net_flow_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="options_8hpp.html">flow/net_flow/options.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="endpoint_8hpp.html">flow/net_flow/endpoint.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;flow/error/error.hpp&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &quot;<a class="code" href="net__flow_2error_2error_8hpp.html">flow/net_flow/error/error.hpp</a>&quot;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#include &quot;<a class="code" href="server__socket_8hpp.html">flow/net_flow/server_socket.hpp</a>&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#include &quot;<a class="code" href="linked__hash__map_8hpp.html">flow/util/linked_hash_map.hpp</a>&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#include &quot;<a class="code" href="util_2util_8hpp.html">flow/util/util.hpp</a>&quot;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#include &quot;<a class="code" href="sched__task__fwd_8hpp.html">flow/util/sched_task_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#include &quot;<a class="code" href="low__lvl__io_8hpp.html">flow/net_flow/detail/low_lvl_io.hpp</a>&quot;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#include &quot;<a class="code" href="socket__buffer_8hpp.html">flow/net_flow/detail/socket_buffer.hpp</a>&quot;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#include &quot;<a class="code" href="socket__stats_8hpp.html">flow/net_flow/detail/stats/socket_stats.hpp</a>&quot;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="preprocessor">#include &quot;<a class="code" href="shared__ptr__alias__holder_8hpp.html">flow/util/shared_ptr_alias_holder.hpp</a>&quot;</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="preprocessor">#include &lt;boost/utility.hpp&gt;</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#include &lt;boost/enable_shared_from_this.hpp&gt;</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="preprocessor">#include &lt;boost/move/unique_ptr.hpp&gt;</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1net__flow.html">flow::net_flow</a></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>{</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"></span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment">/**</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * A peer (non-server) socket operating over the Flow network protocol, with optional stream-of-bytes and</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * reliability support.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * Reliability is enabled or disabled via a socket option, Peer_socket_options::m_st_rexmit_on,</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * at socket creation.  Use unreliable mode with care -- see send() method doc header for details.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * ### Life cycle of a Peer_socket ###</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * A given Peer_socket can arise either by connecting to</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * Server_socket on a Node (Node::connect() or Node::sync_connect()), or by listening on a</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * Node&#39;s Server_socket and accepting such a connection (Server_socket::accept() or</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * Server_socket::sync_accept()).  In all cases, Node or Server_socket generates a new Peer_socket</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * and returns it (factory pattern).  Peer_socket is not instantiable otherwise.  A Peer_socket</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * cannot be deleted explicitly by the user and will only be returned via `boost::shared_ptr&lt;&gt;`; when</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * both the Node and all user code no longer refers to it, the Peer_socket will be destroyed.</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> *</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * Once a `net_flow` user has a Peer_socket object, that object represents a socket in one of the</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * following basic states:</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> *</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> *   - Open.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> *     - Sub-states:</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> *       - Connecting.  (Never Writable, never Readable.)</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> *       - Connected.  (May be Writable, may be Readable.)</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> *       - Disconnecting.  (May be Readable, never Writable.)</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> *   - Closed.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> *     - Socket can neither read nor write.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> *</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> * Open.Connecting means means Node initiated a connect to the given server, and this is in</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> * progress. Open.Connected means the connection to the other Node is fully functional.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> * Open.Disconnecting means either our side or the other side has initiated a clean or abrupt</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> * disconnect, but it is not yet entirely finished (background handshaking is happening, you have</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> * not read all available data or sent all queued data, etc.).</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> *</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * In either case, reading and writing may or may not be possible at a given time, depending on the</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * state of the internal buffers and the data having arrived on the logical connection.  Thus all</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> * Open sub-states can and often should be treated the same way in a typical Flow-protocol-using algorithm:</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> * simply determine when the Peer_socket is Readable, and read; and similarly for Writable and</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> * write.  Thus the sub-states are distinguished for informational/diagnostic purposes only, as user</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> * reading/writing logic in these states should usually be identical.</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> *</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * @todo Closing connection considerations.  May implement closing only via timeouts at first (as</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * opposed to explicit closing).  Below text refers to `close_final()` and `close_start()`, but those</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * are just ideas and may be replaced with timeout, or nothing.  At this time, the only closing</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * supported is abrupt close due to error or abrupt close via close_abruptly().</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> *</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> * Closed means that the Peer_socket has become disconnected, and no data can possibly be</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> * received or sent, AND that Node has no more background internal operations to perform and has</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> * disowned the Peer_socket.  In other words, a Closed Peer_socket is entirely dead.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> *</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> * Exactly the following state transitions are possible for a given Peer_socket returned by Node:</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> *</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> *    - start =&gt; Closed</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> *    - start =&gt; Open</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *    - Open =&gt; Closed</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> *</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> * Note, in particular, that Closed is final; socket cannot move from Closed to</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * Open.  If after an error or valid disconnection you want to reestablish a</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> * connection, obtain a new Peer_socket from Node&#39;s factories.  Rationale (subject to change):</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> * this cuts down on state having to be tracked inside a Peer_socket, while the interface becomes</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> * simpler without much impact on usability.  Anti-rationale: contradicts BSD socket and boost.asio</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> * established practices; potentially more resource-intensive/slower in the event of errors and</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> * disconnects.  Why IMO rationale &gt; anti-rationale: it&#39;s simpler, and the potential problems do not</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> * appear immediately serious; added statefulness can be added later if found desirable.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> *</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> * Receving, sending, and buffers: Peer_socket, like a TCP socket, has a Receive buffer (a/k/a</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * FIFO queue of bytes) of some maximum size and a Send buffer (a/k/a FIFO queue of bytes) of some</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> * maximum size. They are typically not directly exposed via the interface, but their existence</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * affects documented behavior.  I formally describe them here, but generally they work similarly to</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> * TCP socket Send/Receive buffers.</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> *</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> * The Receive buffer: Contains bytes asynchronously received on the connection that have not yet</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> * been removed with a `*receive()` method.  Any bytes that asynchronously arrive on the connection are</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> * asynchronously stored to the buffer on the other side of the buffer in a queued fashion.</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> *</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * The Send buffer: Contains bytes intended to be asynchronously sent on the connection that have</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * been placed there by a `*send()` method but not yet sent on the connection.  Any bytes that are</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> * asynchronously sent on the connection are asynchronously removed from the buffer on the other</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> * side of the buffer in a queued fashion.</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> *</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> * With that in mind, here are the definitions of Readable and Writable while state is Open:</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> *</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> *   - Readable &lt;=&gt; Data available in internal Receive buffer, and user has not explicitly announced</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> *                  via `close_final()` they&#39;re not interested in reading further.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> *   - Writable &lt;=&gt; Space for data available in internal Send buffer, and the state is Open.Connected.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> *</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> * Note that neither definition really cares about the state of the network connection (e.g., could</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> * bytes actually be sent over the network at the moment?).  There is one caveat: A</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> * socket is not Writable until Open.Connecting state is transitioned away from; this prevents user</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> * from buffering up send data before the connection is ready.  (Allowing that would not necessarily</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> * be wrong, but I&#39;m taking a cue from BSD socket semantics on this, as they seem to be convenient.)</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> *</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> * In Open, the following archetypal operations are provided.  (In Closed all</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> * immediately fail; in Open.Disconnecting some immediately fail if `close*()` has been called.)  Let</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> * R be the current size of data in the Receive buffer, and S be the available space for data in the</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> * Send buffer.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> *</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> *   - `receive(N)`.  If Readable, return to caller `min(N, R)` oldest data to have been received from</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> *     the other side, and remove them from Receive buffer.  Otherwise do nothing.</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> *   - `send(N)`.  If Writable, take from caller `min(N, S)` data to be appended to the Send</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> *     buffer and, when possible, sent to the other side.  Otherwise do nothing.</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> *   - `sync_receive(N)`.  If Readable, `receive(N)`.  Otherwise sleep until Readable, then `receive(N)`.</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> *   - `sync_send(N)`.  If Writable, `send(N)`.  Otherwise sleep until Writable, then `send(N)`.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> *</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> * These are similar to TCP Receive and Send APIs in non-blocking mode, and TCP Receive and Send APIs in</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> * blocking mode, respectively.  There may be other similarly themed methods, but all use these as</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> * semantic building blocks.</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> *</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> * To understand the order of events, one can think of a disconnect-causing event (like a graceful</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> * close initiation from the remote socket) as a piece of data itself.  Thus, for example, if 5</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> * bytes are received and placed into the Receive buffer without being read by the user, and then a</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * connection close is detected, the socket will be Readable until the 5 bytes have been</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> * receive()ed, and the next receive() (or send()) would yield the error, since that&#39;s the order</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> * things happened.  Similarly, suppose you&#39;ve sent 5 bytes, but they haven&#39;t been yet</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> * sent over the wire and are sitting in the Send buffer.  Then you trigger a graceful connection close.</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> * First the 5 bytes will be sent if possible, and then the closing procedure will actually begin.</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> *</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> * Abrupt closes such as connection resets may force both buffers to be immediately emptied without</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> * giving to the user or writing to the other side, so that the above rule does not have to apply.</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> * Typically a connection reset means the socket is immediately unusable no matter what was in the</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> * buffers at the time, per BSD socket semantics.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> *</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> * ### Efficiently reading/writing ###</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> * The `sync_*`() methods are efficient, in that they use no processor</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> * cycles until Readable or Writable is achieved (i.e., they sleep until that point).  The</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> * non-blocking versions don&#39;t sleep/block, however.  For a program using them to be efficient it</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> * should sleep until Readable or Writable and only then call receive()/send(), when data are</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> * certainly available for immediate reading or writing.  Moreover, a complex program is likely to</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> * want to perform this sleep-and-conditional-wake on a set of several Peer_socket objects simultaneously</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> * (similarly to `select()`, `epoll*()`, etc.).  Use class Event_set for this purpose.</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> *</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> * Same as for Node.  (Briefly: all operations safe for simultaneous execution on</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> * separate or the same object.)</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> *</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> * Implementation notes</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> * --------------------</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> *</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> * While to a user a Peer_socket appears as a nearly self-sufficient object (i.e., you can do things</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> * like `s-&gt;send()`, which means &#39;socket `s`, send some data!&#39;&#39;), the most reasonable way to internally</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> * implement this is to have Node contain the logic behind a Peer_socket (and how it works together</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> * with other Peer_socket objects and other internal infrastructure).  Thus Node is the class with all of</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> * the logic behind (for example) `s-&gt;send()`.  Peer_socket then, privately, is not too much more than a</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> * collection of data (like a `struct` almost) to help Node.</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> *</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> * Therefore Peer_socket provides a clean object-oriented public interface to the user but, on the</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> * implementation side, is basically a data store (with Node as `friend`) and forwards the logic to</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> * the originating Node.  One idea to make this dichotomy more cleanly expressed (e.g., without</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> * `friend`) was to make Peer_socket a pure interface and have Node produce `Peer_socket_impl`</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> * objects, where `Peer_socket_impl` implements Peer_socket and is itself private to the user (a</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> * classic factory pattern).  Unfortunately defining function templates such as `send&lt;Buffers&gt;()`</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> * (where `Buffers` is an arbitrary `Buffers` concept model) as pure `virtual` functions is not really</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> * possible in C++.  Since such a templated interface can be highly convenient (see boost.asio with</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> * its seamless support for buffers and buffer sequences of most types, including scatter-gather),</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> * the usefulness of the interface trumps implementation beauty.</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> *</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> * To prevent node.cpp from being unmanageably large (and also because it makes sense),</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> * implementations for Node methods that deal only with an individual Peer_socket reside in</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"> * peer_socket.cpp (even though they are members of Node, since, again, the logic is all forwarded to Node).</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"> *</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"> * @todo Rename `State` and `Open_sub_state` to `Phase` and `Open_sub_phase` respectively; and</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment"> * `Int_state` to `State`.  Explain difference between phases (application-layer, user-visible and used</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment"> * close to application layer) and states (transport layer, internal).</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment"> *</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment"> * @todo Look into a way to defeat the need for boiler-plate trickery -- with low but non-zero perf cost --</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"> * involving `*_socket`-vs-`Node` circular references in method templates, such as the way</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"> * Peer_socket::send() and Peer_socket::receive() internally make `Function&lt;&gt;`s before forwarding to the core</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"> * in Node.  Can this be done with `.inl` files?  Look into how Boost internally uses `.inl` files; this could</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"> * inspire a solution... or not.</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment"> */</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html">  216</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Peer__socket.html">Peer_socket</a> :</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1util_1_1Null__interface.html">util::Null_interface</a>,</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span>  <span class="comment">// Endow us with shared_ptr&lt;&gt;s ::Ptr and ::Const_ptr (syntactic sugar).</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1util_1_1Shared__ptr__alias__holder.html">util::Shared_ptr_alias_holder</a>&lt;boost::shared_ptr&lt;Peer_socket&gt;&gt;,</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span>  <span class="comment">// Allow access to Ptr(this) from inside Peer_socket methods.  Just call shared_from_this().</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span>  <span class="keyword">public</span> boost::enable_shared_from_this&lt;Peer_socket&gt;,</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1log_1_1Log__context.html">log::Log_context</a>,</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span>{</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment"></span> </div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment">  /// State of a Peer_socket.</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a6a9bb727c8982f24bcf978c10c2c7345">  229</a></span><span class="comment"></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Peer__socket.html#a6a9bb727c8982f24bcf978c10c2c7345">State</a></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span>  {<span class="comment"></span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment">    /// Future reads or writes may be possible.  A socket in this state may be Writable or Readable.</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment"></span>    S_OPEN,<span class="comment"></span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment">    /// Neither future reads nor writes are possible, AND Node has disowned the Peer_socket.</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment"></span>    S_CLOSED</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span>  };</div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment"></span> </div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment">  /// The sub-state of a Peer_socket when state is State::S_OPEN.</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a6f48d01d1269c9d4260d972baa40e548">  238</a></span><span class="comment"></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Peer__socket.html#a6f48d01d1269c9d4260d972baa40e548">Open_sub_state</a></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span>  {<span class="comment"></span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">     * This Peer_socket was created through an active connect (Node::connect() and the like), and</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">     * the connection to the remote Node is currently being negotiated by this socket&#39;s Node.</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">     * A socket in this state may be Writable but cannot be Readable.  However, except for</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">     * diagnostic purposes, this state should generally be treated the same as S_CONNECTED.</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">     */</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span>    S_CONNECTING,</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment"></span> </div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">     * This Peer_socket was created through a passive connect (Node::accept() and the like) or an</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">     * active connect (Node::connect() and the like), and the connection is (as far this socket&#39;s</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">     * Node knows) set up and functioning.  A socket in this state may be Writable or Readable.</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">     */</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span>    S_CONNECTED,</div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment"></span> </div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">     * This Peer_socket was created through a passive connect (Node::accept() and the like) or an</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">     * active connect (Node::connect() and the like), but since then either an active close,</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">     * passive close, or an error has begun to close the connection, but data may still possibly</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">     * arrive and be Readable; also data may have been &quot;sent&quot; but still sitting in the Send buffer</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">     * and needs to be sent over the network.  A socket in this state may be Readable but cannot</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">     * be Writable.</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment">     *</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment">     * This implies that a non-S_CLOSED socket may be, at a lower level, disconnected.  For</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">     * example, say there are 5 bytes in the Receive buffer, and the other side sends a graceful</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">     * disconnect packet to this socket.  This means the connection is finished, but the user can</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">     * still receive() the 5 bytes (without blocking).  Then state will remain</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">     * S_OPEN.S_DISCONNECTING until the last of the 5 bytes is received (gone from the buffer); at</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">     * this point state may change to S_CLOSED (pending any other work Node must do to be able to</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">     * disown the socket).</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment">     */</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span>    S_DISCONNECTING</div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span>  }; <span class="comment">// enum class Open_sub_state</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span> </div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment"></span> </div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">  /// Boring `virtual` destructor.  Note that deletion is to be handled exclusively via `shared_ptr`, never explicitly.</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment"></span>  <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a729af2cb3465b67b811d8e9438b5af5d">~Peer_socket</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span> </div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment"></span> </div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   * Current State of the socket.</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   *</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   * @param open_sub_state</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">   *        Ignored if null.  Otherwise, if and only if State::S_OPEN is returned, `*open_sub_state` is set to</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">   *        the current sub-state of `S_OPEN`.</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">   * @return Current main state of the socket.</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   */</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span>  <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Peer__socket.html#a6a9bb727c8982f24bcf978c10c2c7345">State</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#af982953b5136c1df488066eacc293a78">state</a>(<a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Peer__socket.html#a6f48d01d1269c9d4260d972baa40e548">Open_sub_state</a>* open_sub_state = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment"></span> </div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   * Node that produced this Peer_socket.</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   *</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   * @return Pointer to (guaranteed valid) Node; null if state is State::S_CLOSED.</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">   */</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">Node</a>* <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#aa9e7e1be830c901bc7348742e79ba2e7">node</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment"></span> </div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   * Intended other side of the connection (regardless of success, failure, or current State).</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   * For a given Peer_socket, this will always return the same value, even if state is</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   * State::S_CLOSED.</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   *</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   */</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span>  <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a5e423a9fd18a45cc7cc5fc34af29161e">remote_endpoint</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment"></span> </div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment">   * The local Flow-protocol port chosen by the Node (if active or passive open) or user (if passive open) for</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment">   * this side of the connection.  For a given Peer_socket, this will always return the same value,</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment">   * even if state is State::S_CLOSED.  However, when state is State::S_CLOSED, the port may be unused or</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">   * taken by another socket.</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">   *</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">   */</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span>  <a class="code hl_typedef" href="namespaceflow_1_1net__flow.html#a079d8cd87a68d1c5f04c6bce71f0061d">flow_port_t</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a7af387476aa0bdc6b3906c153d824acb">local_port</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment"></span> </div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   * Obtains the serialized connect metadata, as supplied by the user during the connection handshake.</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   * If this side initiated the connection (Node::connect() and friends), then this will equal what</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">   * was passed to the connect_with_metadata() (or similar) method.  More likely, if this side</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">   * accepted the connection (Server_socket::accept() and friends), then this will equal what the</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">   * user on the OTHER side passed to connect_with_metadata() or similar.</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">   *</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment">   * @note It is up to the user to deserialize the metadata portably.  One recommended convention is to</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">   *       use `boost::endian::native_to_little()` (and similar) before connecting; and</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">   *       on the other side use the reverse (`boost::endian::little_to_native()`) before using the value.</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">   *       Packet dumps will show a flipped (little-endian) representation, while with most platforms the conversion</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment">   *       will be a no-op at compile time.  Alternatively use `native_to_big()` and vice-versa.</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment">   * @note If a connect() variant without `_with_metadata` in the name was used, then the metadata are</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">   *       composed of a single byte with the zero value.</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">   * @param buffer</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   *        A buffer to copy the metadata into.</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">   * @return The size of the copied metadata.</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">   */</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a0c99637726b3c2b2ff1dbf14c6c92752">get_connect_metadata</a>(<span class="keyword">const</span> boost::asio::mutable_buffer&amp; buffer,</div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span>                              <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment"></span> </div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">   * Sends (adds to the Send buffer) the given bytes of data up to a maximum internal buffer size;</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">   * and asynchronously sends them to the other side.  The data given is copied into `*this`, in the order</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   * given.  Only as many bytes as possible without the Send buffer size exceeding a certain max are</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   * copied.</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">   *</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">   * The method does not block.  Data are then sent asynchronously (in the background).</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">   *</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">   * Method does nothing except possibly logging if there are no bytes in data.</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment">   *</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="comment">   * ### Error handling ###</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment">   * These are the possible outcomes.</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="comment">   *   1. There is no space in the Send buffer (usually due to network congestion).  Socket not</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment">   *      Writable.  0 is returned; `*err_code` is set to success unless null; no data buffered.</span></div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">   *   2. The socket is not yet fully connected (`S_OPEN+S_CONNECTING` state).  Socket not</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">   *      Writable.  0 is returned; `*err_code` is set to success unless null; no data buffered.</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">   *   3. There is space in the Send buffer, and socket connection is open (`S_OPEN+S_CONNECTED`).</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   *      Socket Writable.  &gt;= 1 is returned; `*err_code` is set to success; data buffered.</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   *   4. The operation cannot proceed due to an error.  0 is returned; `*err_code` is set to the</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   *      specific error unless null; no data buffered.  (If `err_code` null, Runtime_error thrown.)</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   *</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   * The semantics of -3- (the success case) are as follows.  N bytes will be copied into Send</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   * buffer from the start of the Const_buffer_sequence data.  These N bytes may be spread across 1</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   * or more buffers in that sequence; the subdivision structure of the sequence of bytes into</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   * buffers has no effect on what will be buffered in Send buffer (e.g., &quot;data&quot; could be N+ 1-byte</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   * buffers, or one N+-byte buffer -- the result would be the same).  N equals the smaller of: the</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment">   * available space in the Send buffer; and `buffer_size(data)`.  We return N.</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment">   *</span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment">   * ### Reliability and ordering guarantees: if the socket option rexmit-on is enabled ###</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment">   * Reliability and ordering are guaranteed, and there is no notion of message boundaries.  There is no possibility</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment">   * of data duplication.  In other words full stream-of-bytes functionality is provided, as in TCP.</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment">   *</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">   * ### Reliability and ordering guarantees: if the socket option rexmit-on is NOT enabled ###</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment">   * NO reliability guarantees are given, UNLESS *ALL* calls to send() (and other `*send`() methods)</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment">   * satisfy the condition: &#39;`buffer_size(data)` is a multiple of `sock-&gt;max_block_size()`&#39;; AND all</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">   * calls to receive() (and other `*receive()` methods) on the OTHER side satisfy the condition:</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   * &#39;`buffer_size(target)` is a multiple of `sock-&gt;max_block_size()`.&#39;  If and only if these guidelines</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   * are followed, and there is no connection closure, the following reliability guarantee is made:</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">   *</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   * Let a &quot;block&quot; be a contiguous chunk of bytes in a &quot;data&quot; buffer sequence immediately following</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   * another &quot;block,&quot; except the first &quot;block&quot; in a connection, which begins with the first byte of</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   * the &quot;data&quot; buffer sequence passed to the first `*send()` call on that connection.  Then: Each</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   * given block will either be available to `*receive()` on the other side exactly once and without</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   * corruption; or not available to `*receive()` at all.  Blocks may arrive in a different order than</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">   * specified here, including with respect to other `*send()` calls performed before or after this</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment">   * one.  In other words, these are guaranteed: block boundary preservation, protection against</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment">   * corruption, protection again duplication.  These are not guaranteed: order preservation,</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment">   * delivery.  Informally, the latter factors are more likely to be present on higher quality</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="comment">   * network paths.</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment">   *</span></div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">   * @tparam Const_buffer_sequence</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment">   *         Type that models the boost.asio `ConstBufferSequence` concept (see Boost docs).</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   *         Basically, it&#39;s any container with elements convertible to `boost::asio::const_buffer`;</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   *         and bidirectional iterator support.  Examples: `vector&lt;const_buffer&gt;`, `list&lt;const_buffer&gt;`.</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   *         Why allow `const_buffer` instead of, say, `Sequence` of bytes?  Same reason as boost.asio&#39;s</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   *         send functions: it allows a great amount of flexibility without sacrificing performance,</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   *         since `boost::asio::buffer()` function can adapt lots of different objects (arrays,</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">   *         `vector`s, `string`s, and more -- composed of bytes, integers, and more).</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment">   * @param data</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">   *        Buffer sequence from which a stream of bytes to add to Send buffer will be obtained.</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.</span></div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment">   *        Error implies that neither this send() nor any subsequent `*send()` on this socket</span></div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="comment">   *        will succeeed.  (In particular a clean disconnect is an error.)</span></div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment">   * @return Number of bytes (possibly zero) added to buffer.  Always 0 if `bool(*err_code) == true` when</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment">   *         send() returns.</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment">   */</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Const_buffer_sequence&gt;</div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#af90b656d7e0b7e746b8beb4e24717cec">send</a>(<span class="keyword">const</span> Const_buffer_sequence&amp; data, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment"></span> </div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment">   * Blocking (synchronous) version of send().  Acts just like send(), except that if Socket is not</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">   * immediately Writable (i.e., send() would return 0 and no error), waits until it is Writable</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   * (send() would return either &gt;0, or 0 and an error) and returns `send(data, err_code)`.  If a</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   * timeout is specified, and this timeout expires before socket is Writable, acts like send()</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   * executed on an un-Writable socket.</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   *</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment">   * ### Error handling ###</span></div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment">   * These are the possible outcomes (assuming there are data in the argument `data`).</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment">   *   1. There is space in the Send buffer, and socket connection</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment">   *      is open (`S_OPEN+S_CONNECTED`).  Socket Writable.  &gt;= 1 is returned; `*err_code` is set to</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment">   *      success unless null; data buffered.</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment">   *   2. The operation cannot proceed due to an error.  0 is returned; `*err_code` is set to the</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment">   *      specific error unless null; no data buffered.  (If `err_code` null, Runtime_error thrown.)</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">   *      The code error::Code::S_WAIT_INTERRUPTED means the wait was interrupted</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">   *      (similarly to POSIX&#39;s `EINTR`).</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment">   *   3. Neither condition above is detected before the timeout expires (if provided).</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span><span class="comment">   *      Output semantics are the same as in 2, with the specific code error::Code::S_WAIT_USER_TIMEOUT.</span></div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment">   *</span></div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment">   * The semantics of -1- (the success case) equal those of send().</span></div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">   *</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   * Note that it is NOT possible to return 0 and no error.</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   *</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   * Tip: Typical types you might use for `max_wait`: `boost::chrono::milliseconds`,</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment">   * `boost::chrono::seconds`, `boost::chrono::high_resolution_clock::duration`.</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment">   *</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment">   * @see The version of sync_send() with no timeout.</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment">   * @tparam Rep</span></div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment">   *         See boost::chrono::duration documentation (and see above tip).</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">   * @tparam Period</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment">   *         See boost::chrono::duration documentation (and see above tip).</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment">   * @tparam Const_buffer_sequence</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">   *         See send().</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   * @param data</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   *        See send().</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span><span class="comment">   * @param max_wait</span></div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span><span class="comment">   *        The maximum amount of time from now to wait before giving up on the wait and returning.</span></div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span><span class="comment">   *        `&quot;duration&lt;Rep, Period&gt;::max()&quot;` will eliminate the time limit and cause indefinite wait</span></div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment">   *        (i.e., no timeout).</span></div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.</span></div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment">   *        Error, except `WAIT_INTERRUPTED` or `WAIT_USER_TIMEOUT`, implies that</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span><span class="comment">   *        neither this send() nor any subsequent send() on this socket</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment">   *        will succeeed.  (In particular a clean disconnect is an error.)</span></div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment">   * @return Number of bytes (possibly zero) added to Send buffer.  Always 0 if `bool(*err_code) == true`</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment">   *         when sync_send() returns.</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment">   */</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period, <span class="keyword">typename</span> Const_buffer_sequence&gt;</div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a70629642551f18e474b87c128d2d77e2">sync_send</a>(<span class="keyword">const</span> Const_buffer_sequence&amp; data,</div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span>                   <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span><span class="comment"></span> </div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span><span class="comment">   * `sync_send()` operating in `nullptr_t` mode, wherein -- if Writable state is reached -- the actual data</span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span><span class="comment">   * are not moved out of any buffer, leaving that to the caller to do if desired.  Hence, this is a way of waiting</span></div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span><span class="comment">   * for Writable state that could be more concise in some situations than Event_set::sync_wait().</span></div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment">   *</span></div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment">   * ### Error handling ###</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment">   * These are the possible outcomes:</span></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment">   *   1. There is space in the Send buffer; and socket is fully connected</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment">   *      (`S_OPEN+S_CONNECTED`).  Socket</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span><span class="comment">   *      Writable.  `true` is returned; `*err_code` is set to success unless null.</span></div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span><span class="comment">   *   2. The operation cannot proceed due to an error.  `false` is returned; `*err_code` is set to the</span></div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span><span class="comment">   *      specific error unless null.  `*err_code == S_WAIT_INTERRUPTED` means the wait was</span></div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span><span class="comment">   *      interrupted (similarly to POSIX&#39;s `EINTR`).  (If `err_code` null, Runtime_error thrown.)</span></div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span><span class="comment">   *   3. Neither condition above is detected before the timeout expires (if provided).</span></div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="comment">   *      Output semantics are the same as in 2, with the specific code error::Code::S_WAIT_USER_TIMEOUT.</span></div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="comment">   *</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="comment">   * Note that it is NOT possible to return `false` and no error.</span></div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="comment">   *</span></div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span><span class="comment">   * Tip: Typical types you might use for `max_wait`: `boost::chrono::milliseconds`,</span></div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="comment">   * `boost::chrono::seconds`, `boost::chrono::high_resolution_clock::duration`.</span></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span><span class="comment">   *</span></div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span><span class="comment">   * @tparam Rep</span></div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span><span class="comment">   *         See other sync_send().</span></div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span><span class="comment">   * @tparam Period</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment">   *         See other sync_send().</span></div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment">   * @param max_wait</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span><span class="comment">   *        See other sync_receive().</span></div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span><span class="comment">   *        Error, except `WAIT_INTERRUPTED` or `WAIT_USER_TIMEOUT`, implies that</span></div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment">   *        neither this nor any subsequent send() on this socket</span></div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span><span class="comment">   *        will succeeed.  (In particular a clean disconnect is an error.)</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span><span class="comment">   * @return `true` if 1+ bytes are possible to add to Send buffer; `false` if either a timeout has occurred (bytes</span></div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span><span class="comment">   *         not writable), or another error has occurred.</span></div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span><span class="comment">   */</span></div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period&gt;</div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a70629642551f18e474b87c128d2d77e2">sync_send</a>(std::nullptr_t,</div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span>                 <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span><span class="comment"></span> </div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="comment">   * Equivalent to `sync_send(data, duration::max(), err_code)`; i.e., sync_send() with no timeout.</span></div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span><span class="comment">   *</span></div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span><span class="comment">   * @tparam Const_buffer_sequence</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span><span class="comment">   *         See other sync_send().</span></div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment">   * @param data</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span><span class="comment">   *        See other sync_send().</span></div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment">   *        See other sync_send().</span></div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment">   * @return See other sync_send().</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span><span class="comment">   */</span></div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Const_buffer_sequence&gt;</div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a70629642551f18e474b87c128d2d77e2">sync_send</a>(<span class="keyword">const</span> Const_buffer_sequence&amp; data, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span><span class="comment"></span> </div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><span class="comment">   * Equivalent to `sync_send(nullptr, duration::max(), err_code)`; i.e., `sync_send(nullptr_t)`</span></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span><span class="comment">   * with no timeout.</span></div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="comment">   *</span></div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="comment">   *        See other sync_receive().</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="comment">   * @return See other sync_receive().</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><span class="comment">   */</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a70629642551f18e474b87c128d2d77e2">sync_send</a>(std::nullptr_t, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span><span class="comment"></span> </div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span><span class="comment">   * Receives (consumes from the Receive buffer) bytes of data, up to a given maximum</span></div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span><span class="comment">   * cumulative number of bytes as inferred from size of provided target buffer sequence.  The data</span></div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span><span class="comment">   * are copied into the user&#39;s structure and then removed from the Receive buffer.</span></div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span><span class="comment">   *</span></div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span><span class="comment">   * The method does not block.  In particular if there are no data already received from the other</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span><span class="comment">   * side, we return no data.</span></div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span><span class="comment">   *</span></div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span><span class="comment">   * If the provided buffer has size zero, the method is a NOOP other than possibly logging.</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span><span class="comment">   *</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span><span class="comment">   * ### Error handling ###</span></div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span><span class="comment">   * These are the possible outcomes.</span></div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span><span class="comment">   *   1. There are no data in the Receive buffer.  Socket not Readable.  0 is returned;</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span><span class="comment">   *      `*err_code` is set to success unless null; no data returned.</span></div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span><span class="comment">   *   2. The socket is not yet fully connected (`S_OPEN+S_CONNECTING`).  Socket not</span></div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span><span class="comment">   *      Readable.  0 is returned; `*err_code` is set to success unless null; no data returned.</span></div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno">  540</span><span class="comment">   *   3. There are data in the Receive buffer; and socket is fully connected (`S_OPEN+S_CONNECTED`)</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span><span class="comment">   *      or gracefully shutting down (`S_OPEN+S_DISCONNECTING`).  Socket Readable.  &gt;= 1 is returned;</span></div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span><span class="comment">   *      *err_code is set to success; data returned.</span></div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span><span class="comment">   *   4. The operation cannot proceed due to an error.  0 is returned; `*err_code` is set to the</span></div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno">  544</span><span class="comment">   *      specific error; no data buffered.  (If `err_code` null, Runtime_error thrown.)</span></div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno">  545</span><span class="comment">   *</span></div>
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno">  546</span><span class="comment">   * The semantics of -3- (the success case) are as follows.  N bytes will be copied from Receive</span></div>
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno">  547</span><span class="comment">   * buffer beginning at the start of the `Mutable_buffer_sequence target`.  These N bytes may be</span></div>
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno">  548</span><span class="comment">   * spread across 1 or more buffers in that sequence; the subdivision structure of the sequence of</span></div>
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno">  549</span><span class="comment">   * bytes into buffers has no effect on the bytes, or order thereof, that will be moved from the</span></div>
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno">  550</span><span class="comment">   * Receive buffer (e.g., `target` could be N+ 1-byte buffers, or one N+-byte buffer</span></div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno">  551</span><span class="comment">   * -- the popped Receive buffer would be the same, as would be the extracted bytes).  N equals the</span></div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno">  552</span><span class="comment">   * smaller of: the available bytes in the Receive buffer; and `buffer_size(target)`.  We return N.</span></div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno">  553</span><span class="comment">   *</span></div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span><span class="comment">   * ### Reliability and ordering guarantees ###</span></div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span><span class="comment">   * See the send() doc header.</span></div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span><span class="comment">   *</span></div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno">  557</span><span class="comment">   * @tparam Mutable_buffer_sequence</span></div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span><span class="comment">   *         Type that models the boost.asio `MutableBufferSequence` concept (see Boost docs).</span></div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno">  559</span><span class="comment">   *         Basically, it&#39;s any container with elements convertible to `boost::asio::mutable_buffer`;</span></div>
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno">  560</span><span class="comment">   *         and bidirectional iterator support.  Examples: `vector&lt;mutable_buffer&gt;`,</span></div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno">  561</span><span class="comment">   *         `list&lt;mutable_buffer&gt;`.  Why allow `mutable_buffer` instead of, say, `Sequence` of bytes?</span></div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno">  562</span><span class="comment">   *         Same reason as boost.asio&#39;s receive functions: it allows a great amount of flexibility</span></div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno">  563</span><span class="comment">   *         without sacrificing performance, since `boost::asio::buffer()` function can adapt lots of</span></div>
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno">  564</span><span class="comment">   *         different objects (arrays, `vector`s, `string`s, and more of bytes, integers, and more).</span></div>
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno">  565</span><span class="comment">   * @param target</span></div>
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno">  566</span><span class="comment">   *        Buffer sequence to which a stream of bytes to consume from Receive buffer will be</span></div>
<div class="line"><a id="l00567" name="l00567"></a><span class="lineno">  567</span><span class="comment">   *        written.</span></div>
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno">  568</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno">  569</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.</span></div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno">  570</span><span class="comment">   *        Error implies that neither this receive() nor any subsequent receive() on this socket</span></div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno">  571</span><span class="comment">   *        will succeeed.  (In particular a clean disconnect is an error.)</span></div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno">  572</span><span class="comment">   * @return The number of bytes consumed (placed into `target`).  Always 0 if `bool(*err_code) == true`</span></div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno">  573</span><span class="comment">   *         when receive() returns.</span></div>
<div class="line"><a id="l00574" name="l00574"></a><span class="lineno">  574</span><span class="comment">   */</span></div>
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno">  575</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Mutable_buffer_sequence&gt;</div>
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno">  576</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#aeb88e9253cc3f52269cb762c8e57e6d0">receive</a>(<span class="keyword">const</span> Mutable_buffer_sequence&amp; target, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00577" name="l00577"></a><span class="lineno">  577</span><span class="comment"></span> </div>
<div class="line"><a id="l00578" name="l00578"></a><span class="lineno">  578</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00579" name="l00579"></a><span class="lineno">  579</span><span class="comment">   * Blocking (synchronous) version of receive().  Acts just like receive(), except that if socket</span></div>
<div class="line"><a id="l00580" name="l00580"></a><span class="lineno">  580</span><span class="comment">   * is not immediately Readable (i.e., receive() would return 0 and no error), waits until it is</span></div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno">  581</span><span class="comment">   * Readable (receive() would return either &gt;0, or 0 and an error) and returns</span></div>
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno">  582</span><span class="comment">   * `receive(target, err_code)`.  If a timeout is specified, and this timeout expires before socket is</span></div>
<div class="line"><a id="l00583" name="l00583"></a><span class="lineno">  583</span><span class="comment">   * Readable, it acts as if receive() produced error::Code::S_WAIT_USER_TIMEOUT.</span></div>
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno">  584</span><span class="comment">   *</span></div>
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno">  585</span><span class="comment">   * ### Error handling ###</span></div>
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno">  586</span><span class="comment">   * These are the possible outcomes:</span></div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno">  587</span><span class="comment">   *   1. There are data in the Receive buffer; and socket is fully connected</span></div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno">  588</span><span class="comment">   *      (`S_OPEN+S_CONNECTED`) or gracefully shutting down (`S_OPEN+S_DISCONNECTING`).  Socket</span></div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno">  589</span><span class="comment">   *      Readable.  &gt;= 1 is returned; `*err_code` is set to success unless null; data returned.</span></div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno">  590</span><span class="comment">   *   2. The operation cannot proceed due to an error.  0 is returned; `*err_code` is set to the</span></div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno">  591</span><span class="comment">   *      specific error unless null; no data buffered.  `*err_code == S_WAIT_INTERRUPTED` means the wait was</span></div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno">  592</span><span class="comment">   *      interrupted (similarly to POSIX&#39;s `EINTR`).  (If `err_code` null, Runtime_error thrown.)</span></div>
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno">  593</span><span class="comment">   *   3. Neither condition above is detected before the timeout expires (if provided).</span></div>
<div class="line"><a id="l00594" name="l00594"></a><span class="lineno">  594</span><span class="comment">   *      Output semantics are the same as in 2, with the specific code error::Code::S_WAIT_USER_TIMEOUT.</span></div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno">  595</span><span class="comment">   *</span></div>
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno">  596</span><span class="comment">   * The semantics of -1- (the success case) equal those of receive().</span></div>
<div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span><span class="comment">   *</span></div>
<div class="line"><a id="l00598" name="l00598"></a><span class="lineno">  598</span><span class="comment">   * Note that it is NOT possible to return 0 and no error.</span></div>
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno">  599</span><span class="comment">   *</span></div>
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno">  600</span><span class="comment">   * Tip: Typical types you might use for `max_wait`: `boost::chrono::milliseconds`,</span></div>
<div class="line"><a id="l00601" name="l00601"></a><span class="lineno">  601</span><span class="comment">   * `boost::chrono::seconds`, `boost::chrono::high_resolution_clock::duration`.</span></div>
<div class="line"><a id="l00602" name="l00602"></a><span class="lineno">  602</span><span class="comment">   *</span></div>
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno">  603</span><span class="comment">   * @see The version of sync_receive() with no timeout.</span></div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno">  604</span><span class="comment">   * @tparam Rep</span></div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno">  605</span><span class="comment">   *         See `boost::chrono::duration` documentation (and see above tip).</span></div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno">  606</span><span class="comment">   * @tparam Period</span></div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno">  607</span><span class="comment">   *         See `boost::chrono::duration` documentation (and see above tip).</span></div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno">  608</span><span class="comment">   * @tparam Mutable_buffer_sequence</span></div>
<div class="line"><a id="l00609" name="l00609"></a><span class="lineno">  609</span><span class="comment">   *         See receive().</span></div>
<div class="line"><a id="l00610" name="l00610"></a><span class="lineno">  610</span><span class="comment">   * @param target</span></div>
<div class="line"><a id="l00611" name="l00611"></a><span class="lineno">  611</span><span class="comment">   *        See receive().</span></div>
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno">  612</span><span class="comment">   * @param max_wait</span></div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno">  613</span><span class="comment">   *        The maximum amount of time from now to wait before giving up on the wait and returning.</span></div>
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno">  614</span><span class="comment">   *        `&quot;duration&lt;Rep, Period&gt;::max()&quot;` will eliminate the time limit and cause indefinite wait</span></div>
<div class="line"><a id="l00615" name="l00615"></a><span class="lineno">  615</span><span class="comment">   *        (i.e., no timeout).</span></div>
<div class="line"><a id="l00616" name="l00616"></a><span class="lineno">  616</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00617" name="l00617"></a><span class="lineno">  617</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.</span></div>
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno">  618</span><span class="comment">   *        Error, except `WAIT_INTERRUPTED` or `WAIT_USER_TIMEOUT`, implies that</span></div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno">  619</span><span class="comment">   *        neither this receive() nor any subsequent receive() on this socket</span></div>
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno">  620</span><span class="comment">   *        will succeeed.  (In particular a clean disconnect is an error.)</span></div>
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno">  621</span><span class="comment">   * @return Number of bytes (possibly zero) added to target.  Always 0 if `bool(*err_code) == true` when</span></div>
<div class="line"><a id="l00622" name="l00622"></a><span class="lineno">  622</span><span class="comment">   *         sync_receive() returns.</span></div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno">  623</span><span class="comment">   */</span></div>
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno">  624</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period, <span class="keyword">typename</span> Mutable_buffer_sequence&gt;</div>
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno">  625</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a256b77e546fff9394ef8d509e2ae771b">sync_receive</a>(<span class="keyword">const</span> Mutable_buffer_sequence&amp; target,</div>
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno">  626</span>                      <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno">  627</span><span class="comment"></span> </div>
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno">  628</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno">  629</span><span class="comment">   * `sync_receive()` operating in `nullptr_t` mode, wherein -- if Readable state is reached -- the actual data</span></div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno">  630</span><span class="comment">   * are not moved into any buffer, leaving that to the caller to do if desired.  Hence, this is a way of waiting</span></div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno">  631</span><span class="comment">   * for Readable state that could be more concise in some situations than Event_set::sync_wait().</span></div>
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno">  632</span><span class="comment">   *</span></div>
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno">  633</span><span class="comment">   * ### Error handling ###</span></div>
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno">  634</span><span class="comment">   * These are the possible outcomes:</span></div>
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno">  635</span><span class="comment">   *   1. There are data in the Receive buffer; and socket is fully connected</span></div>
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno">  636</span><span class="comment">   *      (`S_OPEN+S_CONNECTED`) or gracefully shutting down (`S_OPEN+S_DISCONNECTING`).  Socket</span></div>
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno">  637</span><span class="comment">   *      Readable.  `true` is returned; `*err_code` is set to success unless null.</span></div>
<div class="line"><a id="l00638" name="l00638"></a><span class="lineno">  638</span><span class="comment">   *   2. The operation cannot proceed due to an error.  `false` is returned; `*err_code` is set to the</span></div>
<div class="line"><a id="l00639" name="l00639"></a><span class="lineno">  639</span><span class="comment">   *      specific error unless null.  `*err_code == S_WAIT_INTERRUPTED` means the wait was</span></div>
<div class="line"><a id="l00640" name="l00640"></a><span class="lineno">  640</span><span class="comment">   *      interrupted (similarly to POSIX&#39;s `EINTR`).  (If `err_code` null, Runtime_error thrown.)</span></div>
<div class="line"><a id="l00641" name="l00641"></a><span class="lineno">  641</span><span class="comment">   *   3. Neither condition above is detected before the timeout expires (if provided).</span></div>
<div class="line"><a id="l00642" name="l00642"></a><span class="lineno">  642</span><span class="comment">   *      Output semantics are the same as in 2, with the specific code error::Code::S_WAIT_USER_TIMEOUT.</span></div>
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno">  643</span><span class="comment">   *</span></div>
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno">  644</span><span class="comment">   * Note that it is NOT possible to return `false` and no error.</span></div>
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno">  645</span><span class="comment">   *</span></div>
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno">  646</span><span class="comment">   * Tip: Typical types you might use for `max_wait`: `boost::chrono::milliseconds`,</span></div>
<div class="line"><a id="l00647" name="l00647"></a><span class="lineno">  647</span><span class="comment">   * `boost::chrono::seconds`, `boost::chrono::high_resolution_clock::duration`.</span></div>
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno">  648</span><span class="comment">   *</span></div>
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno">  649</span><span class="comment">   * @tparam Rep</span></div>
<div class="line"><a id="l00650" name="l00650"></a><span class="lineno">  650</span><span class="comment">   *         See other sync_receive().</span></div>
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno">  651</span><span class="comment">   * @tparam Period</span></div>
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno">  652</span><span class="comment">   *         See other sync_receive().</span></div>
<div class="line"><a id="l00653" name="l00653"></a><span class="lineno">  653</span><span class="comment">   * @param max_wait</span></div>
<div class="line"><a id="l00654" name="l00654"></a><span class="lineno">  654</span><span class="comment">   *        See other sync_receive().</span></div>
<div class="line"><a id="l00655" name="l00655"></a><span class="lineno">  655</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00656" name="l00656"></a><span class="lineno">  656</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.</span></div>
<div class="line"><a id="l00657" name="l00657"></a><span class="lineno">  657</span><span class="comment">   *        Error, except `WAIT_INTERRUPTED` or `WAIT_USER_TIMEOUT`, implies that</span></div>
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno">  658</span><span class="comment">   *        neither this nor any subsequent receive() on this socket</span></div>
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno">  659</span><span class="comment">   *        will succeeed.  (In particular a clean disconnect is an error.)</span></div>
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno">  660</span><span class="comment">   * @return `true` if there are 1+ bytes ready to read; `false` if either a timeout has occurred (no bytes ready), or</span></div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno">  661</span><span class="comment">   *         another error has occurred.</span></div>
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno">  662</span><span class="comment">   */</span></div>
<div class="line"><a id="l00663" name="l00663"></a><span class="lineno">  663</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period&gt;</div>
<div class="line"><a id="l00664" name="l00664"></a><span class="lineno">  664</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a256b77e546fff9394ef8d509e2ae771b">sync_receive</a>(std::nullptr_t,</div>
<div class="line"><a id="l00665" name="l00665"></a><span class="lineno">  665</span>                    <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno">  666</span><span class="comment"></span> </div>
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno">  667</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00668" name="l00668"></a><span class="lineno">  668</span><span class="comment">   * Equivalent to `sync_receive(target, duration::max(), err_code)`; i.e., sync_receive()</span></div>
<div class="line"><a id="l00669" name="l00669"></a><span class="lineno">  669</span><span class="comment">   * with no timeout.</span></div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno">  670</span><span class="comment">   *</span></div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno">  671</span><span class="comment">   * @tparam Mutable_buffer_sequence</span></div>
<div class="line"><a id="l00672" name="l00672"></a><span class="lineno">  672</span><span class="comment">   *         See other sync_receive().</span></div>
<div class="line"><a id="l00673" name="l00673"></a><span class="lineno">  673</span><span class="comment">   * @param target</span></div>
<div class="line"><a id="l00674" name="l00674"></a><span class="lineno">  674</span><span class="comment">   *        See other sync_receive().</span></div>
<div class="line"><a id="l00675" name="l00675"></a><span class="lineno">  675</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00676" name="l00676"></a><span class="lineno">  676</span><span class="comment">   *        See other sync_receive().</span></div>
<div class="line"><a id="l00677" name="l00677"></a><span class="lineno">  677</span><span class="comment">   * @return See other sync_receive().</span></div>
<div class="line"><a id="l00678" name="l00678"></a><span class="lineno">  678</span><span class="comment">   */</span></div>
<div class="line"><a id="l00679" name="l00679"></a><span class="lineno">  679</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Mutable_buffer_sequence&gt;</div>
<div class="line"><a id="l00680" name="l00680"></a><span class="lineno">  680</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a256b77e546fff9394ef8d509e2ae771b">sync_receive</a>(<span class="keyword">const</span> Mutable_buffer_sequence&amp; target, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00681" name="l00681"></a><span class="lineno">  681</span><span class="comment"></span> </div>
<div class="line"><a id="l00682" name="l00682"></a><span class="lineno">  682</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00683" name="l00683"></a><span class="lineno">  683</span><span class="comment">   * Equivalent to `sync_receive(nullptr, duration::max(), err_code)`; i.e., `sync_receive(nullptr_t)`</span></div>
<div class="line"><a id="l00684" name="l00684"></a><span class="lineno">  684</span><span class="comment">   * with no timeout.</span></div>
<div class="line"><a id="l00685" name="l00685"></a><span class="lineno">  685</span><span class="comment">   *</span></div>
<div class="line"><a id="l00686" name="l00686"></a><span class="lineno">  686</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00687" name="l00687"></a><span class="lineno">  687</span><span class="comment">   *        See other sync_receive().</span></div>
<div class="line"><a id="l00688" name="l00688"></a><span class="lineno">  688</span><span class="comment">   * @return See other sync_receive().</span></div>
<div class="line"><a id="l00689" name="l00689"></a><span class="lineno">  689</span><span class="comment">   */</span></div>
<div class="line"><a id="l00690" name="l00690"></a><span class="lineno">  690</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a256b77e546fff9394ef8d509e2ae771b">sync_receive</a>(std::nullptr_t, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno">  691</span><span class="comment"></span> </div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno">  692</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00693" name="l00693"></a><span class="lineno">  693</span><span class="comment">   * Acts as if fatal error error::Code::S_USER_CLOSED_ABRUPTLY has been discovered on the</span></div>
<div class="line"><a id="l00694" name="l00694"></a><span class="lineno">  694</span><span class="comment">   * connection.  Does not block.</span></div>
<div class="line"><a id="l00695" name="l00695"></a><span class="lineno">  695</span><span class="comment">   *</span></div>
<div class="line"><a id="l00696" name="l00696"></a><span class="lineno">  696</span><span class="comment">   * Post-condition: `state() == State::S_CLOSED`.  Additionally, assuming no loss on the</span></div>
<div class="line"><a id="l00697" name="l00697"></a><span class="lineno">  697</span><span class="comment">   * network, the other side will close the connection with error</span></div>
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno">  698</span><span class="comment">   * error::Code::S_CONN_RESET_BY_OTHER_SIDE.</span></div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno">  699</span><span class="comment">   *</span></div>
<div class="line"><a id="l00700" name="l00700"></a><span class="lineno">  700</span><span class="comment">   * Note: Discovering a fatal error on the connection would trigger all event waits on this socket</span></div>
<div class="line"><a id="l00701" name="l00701"></a><span class="lineno">  701</span><span class="comment">   * (sync_send(), sync_receive(), Event_set::sync_wait(), Event_set::async_wait()) to execute on-event</span></div>
<div class="line"><a id="l00702" name="l00702"></a><span class="lineno">  702</span><span class="comment">   * behavior (return, return, return, invoke handler, respectively).  Therefore this method will cause</span></div>
<div class="line"><a id="l00703" name="l00703"></a><span class="lineno">  703</span><span class="comment">   * just that, if applicable.</span></div>
<div class="line"><a id="l00704" name="l00704"></a><span class="lineno">  704</span><span class="comment">   *</span></div>
<div class="line"><a id="l00705" name="l00705"></a><span class="lineno">  705</span><span class="comment">   * Note: As a corollary, a socket closing this way (or any other way) does NOT cause that socket&#39;s</span></div>
<div class="line"><a id="l00706" name="l00706"></a><span class="lineno">  706</span><span class="comment">   * events (if any) to be removed from any Event_set objects.  Clearing an Event_set of all or some</span></div>
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno">  707</span><span class="comment">   * sockets is the Event_set user&#39;s responsibility (the classic way being Event_set::close()).</span></div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno">  708</span><span class="comment">   *</span></div>
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno">  709</span><span class="comment">   * @warning The moment the other side is informed we have abruptly closed the connection, they</span></div>
<div class="line"><a id="l00710" name="l00710"></a><span class="lineno">  710</span><span class="comment">   * will no longer be able to receive() any of it (even if data had been queued up in</span></div>
<div class="line"><a id="l00711" name="l00711"></a><span class="lineno">  711</span><span class="comment">   * their Receive buffer).</span></div>
<div class="line"><a id="l00712" name="l00712"></a><span class="lineno">  712</span><span class="comment">   *</span></div>
<div class="line"><a id="l00713" name="l00713"></a><span class="lineno">  713</span><span class="comment">   * @todo Currently this close_abruptly() is the only way for the user to explicitly close one specified socket.</span></div>
<div class="line"><a id="l00714" name="l00714"></a><span class="lineno">  714</span><span class="comment">   * All other ways are due to error (or other side starting graceful shutdown, once we</span></div>
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno">  715</span><span class="comment">   * implement that).  Once we implement graceful close, via `close_start()` and `close_final()`,</span></div>
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno">  716</span><span class="comment">   * use of close_abruptly() should be discouraged, or it may even be deprecated (e.g.,</span></div>
<div class="line"><a id="l00717" name="l00717"></a><span class="lineno">  717</span><span class="comment">   * `Node`s lack a way to initiate an abrupt close for a specific socket).</span></div>
<div class="line"><a id="l00718" name="l00718"></a><span class="lineno">  718</span><span class="comment">   *</span></div>
<div class="line"><a id="l00719" name="l00719"></a><span class="lineno">  719</span><span class="comment">   * @todo close_abruptly() return `bool` (`false` on failure)?</span></div>
<div class="line"><a id="l00720" name="l00720"></a><span class="lineno">  720</span><span class="comment">   *</span></div>
<div class="line"><a id="l00721" name="l00721"></a><span class="lineno">  721</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00722" name="l00722"></a><span class="lineno">  722</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00723" name="l00723"></a><span class="lineno">  723</span><span class="comment">   *        error::Code::S_NODE_NOT_RUNNING, or -- if socket already closed (`state() == State::S_CLOSED`) --</span></div>
<div class="line"><a id="l00724" name="l00724"></a><span class="lineno">  724</span><span class="comment">   *        then the error that caused the closure.</span></div>
<div class="line"><a id="l00725" name="l00725"></a><span class="lineno">  725</span><span class="comment">   */</span></div>
<div class="line"><a id="l00726" name="l00726"></a><span class="lineno">  726</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a9ab710704237f912eb219f9b8d574afc">close_abruptly</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00727" name="l00727"></a><span class="lineno">  727</span><span class="comment"></span> </div>
<div class="line"><a id="l00728" name="l00728"></a><span class="lineno">  728</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00729" name="l00729"></a><span class="lineno">  729</span><span class="comment">   * Dynamically replaces the current options set (options()) with the given options set.</span></div>
<div class="line"><a id="l00730" name="l00730"></a><span class="lineno">  730</span><span class="comment">   * Only those members of `opts` designated as dynamic (as opposed to static) may be different</span></div>
<div class="line"><a id="l00731" name="l00731"></a><span class="lineno">  731</span><span class="comment">   * between options() and `opts`.  If this is violated, it is an error, and no options are changed.</span></div>
<div class="line"><a id="l00732" name="l00732"></a><span class="lineno">  732</span><span class="comment">   *</span></div>
<div class="line"><a id="l00733" name="l00733"></a><span class="lineno">  733</span><span class="comment">   * Typically one would acquire a copy of the existing options set via options(), modify the</span></div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno">  734</span><span class="comment">   * desired dynamic data members of that copy, and then apply that copy back by calling</span></div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno">  735</span><span class="comment">   * set_options().</span></div>
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno">  736</span><span class="comment">   *</span></div>
<div class="line"><a id="l00737" name="l00737"></a><span class="lineno">  737</span><span class="comment">   * @param opts</span></div>
<div class="line"><a id="l00738" name="l00738"></a><span class="lineno">  738</span><span class="comment">   *        The new options to apply to this socket.  It is copied; no reference is saved.</span></div>
<div class="line"><a id="l00739" name="l00739"></a><span class="lineno">  739</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00740" name="l00740"></a><span class="lineno">  740</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno">  741</span><span class="comment">   *        error::Code::S_STATIC_OPTION_CHANGED, error::Code::S_OPTION_CHECK_FAILED,</span></div>
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno">  742</span><span class="comment">   *        error::Code::S_NODE_NOT_RUNNING.</span></div>
<div class="line"><a id="l00743" name="l00743"></a><span class="lineno">  743</span><span class="comment">   * @return `true` on success, `false` on error.</span></div>
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno">  744</span><span class="comment">   */</span></div>
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno">  745</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a7d31cf18a3c075873de1c46c0176e41f">set_options</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>&amp; opts, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00746" name="l00746"></a><span class="lineno">  746</span><span class="comment"></span> </div>
<div class="line"><a id="l00747" name="l00747"></a><span class="lineno">  747</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno">  748</span><span class="comment">   * Copies this socket&#39;s option set and returns that copy.  If you intend to use set_options() to</span></div>
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno">  749</span><span class="comment">   * modify a socket&#39;s options, we recommend you make the modifications on the copy returned by</span></div>
<div class="line"><a id="l00750" name="l00750"></a><span class="lineno">  750</span><span class="comment">   * options().</span></div>
<div class="line"><a id="l00751" name="l00751"></a><span class="lineno">  751</span><span class="comment">   *</span></div>
<div class="line"><a id="l00752" name="l00752"></a><span class="lineno">  752</span><span class="comment">   * @todo Provide a similar options() method that loads an existing structure (for structure</span></div>
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno">  753</span><span class="comment">   * reuse).</span></div>
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno">  754</span><span class="comment">   *</span></div>
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno">  755</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno">  756</span><span class="comment">   */</span></div>
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno">  757</span>  <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#ad94e37c8cca01f801f13e9e0e0bc857d">options</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno">  758</span><span class="comment"></span> </div>
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno">  759</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno">  760</span><span class="comment">   * Returns a structure containing the most up-to-date stats about this connection.</span></div>
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno">  761</span><span class="comment">   *</span></div>
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno">  762</span><span class="comment">   * @note At the cost of reducing locking overhead in 99.999999% of the Peer_socket&#39;s operation,</span></div>
<div class="line"><a id="l00763" name="l00763"></a><span class="lineno">  763</span><span class="comment">   *       this method may take a bit of time to run.  It&#39;s still probably only 10 times or so slower than</span></div>
<div class="line"><a id="l00764" name="l00764"></a><span class="lineno">  764</span><span class="comment">   *       a simple lock, work, unlock -- there is a condition variable and stuff involved -- but this may</span></div>
<div class="line"><a id="l00765" name="l00765"></a><span class="lineno">  765</span><span class="comment">   *       matter if done very frequently.  So you probably should not.  (Hmmm... where did I get these estimates,</span></div>
<div class="line"><a id="l00766" name="l00766"></a><span class="lineno">  766</span><span class="comment">   *       namely &quot;10 times or so&quot;?)</span></div>
<div class="line"><a id="l00767" name="l00767"></a><span class="lineno">  767</span><span class="comment">   *</span></div>
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno">  768</span><span class="comment">   * @todo Provide a similar info() method that loads an existing structure (for structure</span></div>
<div class="line"><a id="l00769" name="l00769"></a><span class="lineno">  769</span><span class="comment">   * reuse).</span></div>
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno">  770</span><span class="comment">   *</span></div>
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno">  771</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00772" name="l00772"></a><span class="lineno">  772</span><span class="comment">   */</span></div>
<div class="line"><a id="l00773" name="l00773"></a><span class="lineno">  773</span>  <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__info.html">Peer_socket_info</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#aad81cc16fc6f0d353fdc1379e1dd4712">info</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno">  774</span><span class="comment"></span> </div>
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno">  775</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00776" name="l00776"></a><span class="lineno">  776</span><span class="comment">   * The maximum number of bytes of user data per received or sent packet on this connection.  See</span></div>
<div class="line"><a id="l00777" name="l00777"></a><span class="lineno">  777</span><span class="comment">   * Peer_socket_options::m_st_max_block_size.  Note that this method is ESSENTIAL when using the</span></div>
<div class="line"><a id="l00778" name="l00778"></a><span class="lineno">  778</span><span class="comment">   * socket in unreliable mode (assuming you want to implement reliability outside of `net_flow`).</span></div>
<div class="line"><a id="l00779" name="l00779"></a><span class="lineno">  779</span><span class="comment">   *</span></div>
<div class="line"><a id="l00780" name="l00780"></a><span class="lineno">  780</span><span class="comment">   * @return Ditto.</span></div>
<div class="line"><a id="l00781" name="l00781"></a><span class="lineno">  781</span><span class="comment">   */</span></div>
<div class="line"><a id="l00782" name="l00782"></a><span class="lineno">  782</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#aa1f821dde38a7aa572651730744edbd8">max_block_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00783" name="l00783"></a><span class="lineno">  783</span><span class="comment"></span> </div>
<div class="line"><a id="l00784" name="l00784"></a><span class="lineno">  784</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00785" name="l00785"></a><span class="lineno">  785</span><span class="comment">   * The error code that perviously caused state() to become State::S_CLOSED, or success code if state</span></div>
<div class="line"><a id="l00786" name="l00786"></a><span class="lineno">  786</span><span class="comment">   * is not CLOSED.  For example, error::code::S_CONN_RESET_BY_OTHER_SIDE (if was connected) or</span></div>
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno">  787</span><span class="comment">   * error::Code::S_CONN_TIMEOUT (if was connecting)</span></div>
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno">  788</span><span class="comment">   *</span></div>
<div class="line"><a id="l00789" name="l00789"></a><span class="lineno">  789</span><span class="comment">   * @return Ditto.</span></div>
<div class="line"><a id="l00790" name="l00790"></a><span class="lineno">  790</span><span class="comment">   */</span></div>
<div class="line"><a id="l00791" name="l00791"></a><span class="lineno">  791</span>  <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a74f6fd527766fdeb05a96c5c03729a00">disconnect_cause</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00792" name="l00792"></a><span class="lineno">  792</span> </div>
<div class="line"><a id="l00793" name="l00793"></a><span class="lineno">  793</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00794" name="l00794"></a><span class="lineno">  794</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00795" name="l00795"></a><span class="lineno">  795</span><span class="comment"></span> </div>
<div class="line"><a id="l00796" name="l00796"></a><span class="lineno">  796</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno">  797</span><span class="comment">   * Constructs object; initializes most values to well-defined (0, empty, etc.) but not necessarily</span></div>
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno">  798</span><span class="comment">   * meaningful values.</span></div>
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno">  799</span><span class="comment">   *</span></div>
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno">  800</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00801" name="l00801"></a><span class="lineno">  801</span><span class="comment">   *        The Logger implementation to use subsequently.</span></div>
<div class="line"><a id="l00802" name="l00802"></a><span class="lineno">  802</span><span class="comment">   * @param task_engine</span></div>
<div class="line"><a id="l00803" name="l00803"></a><span class="lineno">  803</span><span class="comment">   *        IO service for the timer(s) stored as data member(s).</span></div>
<div class="line"><a id="l00804" name="l00804"></a><span class="lineno">  804</span><span class="comment">   * @param opts</span></div>
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno">  805</span><span class="comment">   *        The options set to copy into this Peer_socket and use subsequently.</span></div>
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno">  806</span><span class="comment">   */</span></div>
<div class="line"><a id="l00807" name="l00807"></a><span class="lineno">  807</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a5003c554807f5b5b58989ad58be48d42">Peer_socket</a>(<a class="code hl_class" href="classflow_1_1log_1_1Logger.html">log::Logger</a>* logger_ptr,</div>
<div class="line"><a id="l00808" name="l00808"></a><span class="lineno">  808</span>                       <a class="code hl_typedef" href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">util::Task_engine</a>* task_engine,</div>
<div class="line"><a id="l00809" name="l00809"></a><span class="lineno">  809</span>                       <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>&amp; opts);</div>
<div class="line"><a id="l00810" name="l00810"></a><span class="lineno">  810</span> </div>
<div class="line"><a id="l00811" name="l00811"></a><span class="lineno">  811</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00812" name="l00812"></a><span class="lineno">  812</span>  <span class="comment">// Friends.</span></div>
<div class="line"><a id="l00813" name="l00813"></a><span class="lineno">  813</span><span class="comment"></span> </div>
<div class="line"><a id="l00814" name="l00814"></a><span class="lineno">  814</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00815" name="l00815"></a><span class="lineno">  815</span><span class="comment">   * See rationale for `friend`ing Node in class Peer_socket documentation header.</span></div>
<div class="line"><a id="l00816" name="l00816"></a><span class="lineno">  816</span><span class="comment">   * @see Node.</span></div>
<div class="line"><a id="l00817" name="l00817"></a><span class="lineno">  817</span><span class="comment">   */</span></div>
<div class="line"><a id="l00818" name="l00818"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a6db9d28bd448a131448276ee03de1e6d">  818</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">Node</a>;<span class="comment"></span></div>
<div class="line"><a id="l00819" name="l00819"></a><span class="lineno">  819</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00820" name="l00820"></a><span class="lineno">  820</span><span class="comment">   * See rationale for `friend`ing Server_socket in class Peer_socket documentation header.</span></div>
<div class="line"><a id="l00821" name="l00821"></a><span class="lineno">  821</span><span class="comment">   * @see Server_socket.</span></div>
<div class="line"><a id="l00822" name="l00822"></a><span class="lineno">  822</span><span class="comment">   */</span></div>
<div class="line"><a id="l00823" name="l00823"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a2165381af6166d76afba06862c762367">  823</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Server__socket.html">Server_socket</a>;<span class="comment"></span></div>
<div class="line"><a id="l00824" name="l00824"></a><span class="lineno">  824</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00825" name="l00825"></a><span class="lineno">  825</span><span class="comment">   * For access to `Sent_pkt_by_sent_when_map` and Sent_packet types, at least.</span></div>
<div class="line"><a id="l00826" name="l00826"></a><span class="lineno">  826</span><span class="comment">   * (Drop_timer has no actual Peer_socket instance to mess with.)</span></div>
<div class="line"><a id="l00827" name="l00827"></a><span class="lineno">  827</span><span class="comment">   */</span></div>
<div class="line"><a id="l00828" name="l00828"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ad1259416e25ed2bd94bce3192c682e5d">  828</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Drop__timer.html">Drop_timer</a>;<span class="comment"></span></div>
<div class="line"><a id="l00829" name="l00829"></a><span class="lineno">  829</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno">  830</span><span class="comment">   * Stats modules have const access to all socket internals.</span></div>
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno">  831</span><span class="comment">   * @see Send_bandwidth_estimator.</span></div>
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno">  832</span><span class="comment">   */</span></div>
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a7c0f36768414ae35afeb525636a41290">  833</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Send__bandwidth__estimator.html">Send_bandwidth_estimator</a>;<span class="comment"></span></div>
<div class="line"><a id="l00834" name="l00834"></a><span class="lineno">  834</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00835" name="l00835"></a><span class="lineno">  835</span><span class="comment">   * Congestion control modules have const access to all socket internals.</span></div>
<div class="line"><a id="l00836" name="l00836"></a><span class="lineno">  836</span><span class="comment">   * @see Congestion_control_classic_data.</span></div>
<div class="line"><a id="l00837" name="l00837"></a><span class="lineno">  837</span><span class="comment">   */</span></div>
<div class="line"><a id="l00838" name="l00838"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a73cd234409fb43c27e1f46f2303ca55d">  838</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Congestion__control__classic__data.html">Congestion_control_classic_data</a>;<span class="comment"></span></div>
<div class="line"><a id="l00839" name="l00839"></a><span class="lineno">  839</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00840" name="l00840"></a><span class="lineno">  840</span><span class="comment">   * Congestion control modules have const access to all socket internals.</span></div>
<div class="line"><a id="l00841" name="l00841"></a><span class="lineno">  841</span><span class="comment">   * @see Congestion_control_classic.</span></div>
<div class="line"><a id="l00842" name="l00842"></a><span class="lineno">  842</span><span class="comment">   */</span></div>
<div class="line"><a id="l00843" name="l00843"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ad1b055f28b89531ad98368286babfdb1">  843</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Congestion__control__classic.html">Congestion_control_classic</a>;<span class="comment"></span></div>
<div class="line"><a id="l00844" name="l00844"></a><span class="lineno">  844</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00845" name="l00845"></a><span class="lineno">  845</span><span class="comment">   * Congestion control modules have const access to all socket internals.</span></div>
<div class="line"><a id="l00846" name="l00846"></a><span class="lineno">  846</span><span class="comment">   * @see Congestion_control_classic_with_bandwidth_est.</span></div>
<div class="line"><a id="l00847" name="l00847"></a><span class="lineno">  847</span><span class="comment">   */</span></div>
<div class="line"><a id="l00848" name="l00848"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a7020b02ef7daffcfd9004e41240f51b8">  848</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Congestion__control__classic__with__bandwidth__est.html">Congestion_control_classic_with_bandwidth_est</a>;</div>
<div class="line"><a id="l00849" name="l00849"></a><span class="lineno">  849</span> </div>
<div class="line"><a id="l00850" name="l00850"></a><span class="lineno">  850</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00851" name="l00851"></a><span class="lineno">  851</span><span class="comment"></span> </div>
<div class="line"><a id="l00852" name="l00852"></a><span class="lineno">  852</span><span class="comment">  /// Short-hand for `shared_ptr` to immutable Drop_timer (can&#39;t use Drop_timer::Ptr due to C++ and circular reference).</span></div>
<div class="line"><a id="l00853" name="l00853"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ae804be57cf09b9bf76eafa8ffff73de6">  853</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#ae804be57cf09b9bf76eafa8ffff73de6">Drop_timer_ptr</a> = boost::shared_ptr&lt;Drop_timer&gt;;</div>
<div class="line"><a id="l00854" name="l00854"></a><span class="lineno">  854</span><span class="comment"></span> </div>
<div class="line"><a id="l00855" name="l00855"></a><span class="lineno">  855</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00856" name="l00856"></a><span class="lineno">  856</span><span class="comment">   * Short-hand for high-performance, non-reentrant, exclusive mutex used to lock #m_opts.</span></div>
<div class="line"><a id="l00857" name="l00857"></a><span class="lineno">  857</span><span class="comment">   *</span></div>
<div class="line"><a id="l00858" name="l00858"></a><span class="lineno">  858</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00859" name="l00859"></a><span class="lineno">  859</span><span class="comment">   * You might notice this seems tailor-made for shared/exclusive (a/k/a multiple-readers-single-writer) mutex.</span></div>
<div class="line"><a id="l00860" name="l00860"></a><span class="lineno">  860</span><span class="comment">   * Why a 2-level mutex instead of a normal exclusive mutex?  Because options can be accessed by</span></div>
<div class="line"><a id="l00861" name="l00861"></a><span class="lineno">  861</span><span class="comment">   * thread W and various user threads, in the vast majority of the time to read option values.  On</span></div>
<div class="line"><a id="l00862" name="l00862"></a><span class="lineno">  862</span><span class="comment">   * the other hand, rarely, #m_opts may be modified via set_options().  To avoid thread contention</span></div>
<div class="line"><a id="l00863" name="l00863"></a><span class="lineno">  863</span><span class="comment">   * when no one is writing (which is usual), we could use that 2-level type of mutex and apply the appropriate</span></div>
<div class="line"><a id="l00864" name="l00864"></a><span class="lineno">  864</span><span class="comment">   * (shared or unique) lock depending on the situation.  So why not?  Answer:</span></div>
<div class="line"><a id="l00865" name="l00865"></a><span class="lineno">  865</span><span class="comment">   * While a shared/exclusive mutex sounds lovely in theory -- and perhaps</span></div>
<div class="line"><a id="l00866" name="l00866"></a><span class="lineno">  866</span><span class="comment">   * if its implementation were closer to the hardware it would be lovely indeed -- in practice it seems its</span></div>
<div class="line"><a id="l00867" name="l00867"></a><span class="lineno">  867</span><span class="comment">   * implementation just causes performance problems rather than solving them.  Apparently that&#39;s why</span></div>
<div class="line"><a id="l00868" name="l00868"></a><span class="lineno">  868</span><span class="comment">   * it was rejected by C++11 standards people w/r/t inclusion in that standard.  The people involved</span></div>
<div class="line"><a id="l00869" name="l00869"></a><span class="lineno">  869</span><span class="comment">   * explained their decision here: http://permalink.gmane.org/gmane.comp.lib.boost.devel/211180.</span></div>
<div class="line"><a id="l00870" name="l00870"></a><span class="lineno">  870</span><span class="comment">   * So until that is improved, just do this.  I&#39;m not even adding a to-do for fixing this, as that seems</span></div>
<div class="line"><a id="l00871" name="l00871"></a><span class="lineno">  871</span><span class="comment">   * unlikely anytime soon.  Update: C++17 added `std::shared_mutex`, and C++14 added a similar thing named</span></div>
<div class="line"><a id="l00872" name="l00872"></a><span class="lineno">  872</span><span class="comment">   * something else.  Seems like a good time to revisit this -- if not to materially improve #Options_mutex</span></div>
<div class="line"><a id="l00873" name="l00873"></a><span class="lineno">  873</span><span class="comment">   * performance then to gain up-to-date knowledge on the topic, specifically whether `shared_mutex` is fast now.</span></div>
<div class="line"><a id="l00874" name="l00874"></a><span class="lineno">  874</span><span class="comment">   * Update: Apparently as of Boost-1.80 the Boost.thread impl of `shared_mutex` is lacking in perf, and there</span></div>
<div class="line"><a id="l00875" name="l00875"></a><span class="lineno">  875</span><span class="comment">   * is a ticket filed for many years for this.  Perhaps gcc `std::shared_mutex` is fine.  However research</span></div>
<div class="line"><a id="l00876" name="l00876"></a><span class="lineno">  876</span><span class="comment">   * suggests it&#39;s less about this nitty-gritty of various impls and more the following bottom line:</span></div>
<div class="line"><a id="l00877" name="l00877"></a><span class="lineno">  877</span><span class="comment">   * A simple mutex is *very* fast to lock/unlock, and perf problems occur only if one must wait for a lock.</span></div>
<div class="line"><a id="l00878" name="l00878"></a><span class="lineno">  878</span><span class="comment">   * Experts say that it is possible but quite rare that there is enough lock contention to make it &quot;worth it&quot;:</span></div>
<div class="line"><a id="l00879" name="l00879"></a><span class="lineno">  879</span><span class="comment">   * a shared mutex is *much* slower to lock/unlock sans contention.  Only when the read critical sections are</span></div>
<div class="line"><a id="l00880" name="l00880"></a><span class="lineno">  880</span><span class="comment">   * long and very frequently accessed does it become &quot;worth it.&quot;</span></div>
<div class="line"><a id="l00881" name="l00881"></a><span class="lineno">  881</span><span class="comment">   */</span></div>
<div class="line"><a id="l00882" name="l00882"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a1e1379f9a0269d6990f26bf1da045657">  882</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a1e1379f9a0269d6990f26bf1da045657">Options_mutex</a> = <a class="code hl_typedef" href="namespaceflow_1_1util.html#add6ade273326f27eaf9bfd170a909626">util::Mutex_non_recursive</a>;</div>
<div class="line"><a id="l00883" name="l00883"></a><span class="lineno">  883</span><span class="comment"></span> </div>
<div class="line"><a id="l00884" name="l00884"></a><span class="lineno">  884</span><span class="comment">  /// Short-hand for lock that acquires exclusive access to an #Options_mutex.</span></div>
<div class="line"><a id="l00885" name="l00885"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a98c6729b318f28b61e144f8a9b1f4dfc">  885</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a98c6729b318f28b61e144f8a9b1f4dfc">Options_lock</a> = <a class="code hl_typedef" href="namespaceflow_1_1util.html#a5d2247b715da63e4b960909561b90ae7">util::Lock_guard&lt;Options_mutex&gt;</a>;</div>
<div class="line"><a id="l00886" name="l00886"></a><span class="lineno">  886</span><span class="comment"></span> </div>
<div class="line"><a id="l00887" name="l00887"></a><span class="lineno">  887</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00888" name="l00888"></a><span class="lineno">  888</span><span class="comment">   * Short-hand for reentrant mutex type.  We explicitly rely on reentrant behavior, so this isn&#39;t &quot;just in case.&quot;</span></div>
<div class="line"><a id="l00889" name="l00889"></a><span class="lineno">  889</span><span class="comment">   *</span></div>
<div class="line"><a id="l00890" name="l00890"></a><span class="lineno">  890</span><span class="comment">   * @todo This doc header for Peer_socket::Mutex should specify what specific behavior requires mutex reentrance, so</span></div>
<div class="line"><a id="l00891" name="l00891"></a><span class="lineno">  891</span><span class="comment">   * that for example one could reevaluate whether there&#39;s a sleeker code pattern that would avoid it.</span></div>
<div class="line"><a id="l00892" name="l00892"></a><span class="lineno">  892</span><span class="comment">   */</span></div>
<div class="line"><a id="l00893" name="l00893"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ad1e36619c78b15f46576a18678a4ee67">  893</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#ad1e36619c78b15f46576a18678a4ee67">Mutex</a> = <a class="code hl_typedef" href="namespaceflow_1_1util.html#a9c7a5df07c2e86c788de9e6bbaee77d5">util::Mutex_recursive</a>;</div>
<div class="line"><a id="l00894" name="l00894"></a><span class="lineno">  894</span><span class="comment"></span> </div>
<div class="line"><a id="l00895" name="l00895"></a><span class="lineno">  895</span><span class="comment">  /// Short-hand for RAII lock guard of #Mutex.</span></div>
<div class="line"><a id="l00896" name="l00896"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a90abde8badaf451ba6ca615e9936d5df">  896</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a90abde8badaf451ba6ca615e9936d5df">Lock_guard</a> = <a class="code hl_typedef" href="namespaceflow_1_1util.html#a5d2247b715da63e4b960909561b90ae7">util::Lock_guard&lt;Mutex&gt;</a>;</div>
<div class="line"><a id="l00897" name="l00897"></a><span class="lineno">  897</span><span class="comment"></span> </div>
<div class="line"><a id="l00898" name="l00898"></a><span class="lineno">  898</span><span class="comment">  /// Type used for #m_security_token.</span></div>
<div class="line"><a id="l00899" name="l00899"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a59db68ed0c77a9f6e1a7aeeb3df2a6b9">  899</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a59db68ed0c77a9f6e1a7aeeb3df2a6b9">security_token_t</a> = uint64_t;</div>
<div class="line"><a id="l00900" name="l00900"></a><span class="lineno">  900</span><span class="comment"></span> </div>
<div class="line"><a id="l00901" name="l00901"></a><span class="lineno">  901</span><span class="comment">  /// Short-hand for order number type.  0 is reserved.  Caution: Keep in sync with Drop_timer::packet_id_t.</span></div>
<div class="line"><a id="l00902" name="l00902"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a797a524b73e2626fcfefe1be64f4d481">  902</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a797a524b73e2626fcfefe1be64f4d481">order_num_t</a> = <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Sequence__number.html#ab307e12c0cf8cefbe7fb1ec8588af2a8">Sequence_number::seq_num_t</a>;</div>
<div class="line"><a id="l00903" name="l00903"></a><span class="lineno">  903</span><span class="comment"></span> </div>
<div class="line"><a id="l00904" name="l00904"></a><span class="lineno">  904</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00905" name="l00905"></a><span class="lineno">  905</span><span class="comment">   * The state of the socket (and the connection from this end&#39;s point of view) for the internal state</span></div>
<div class="line"><a id="l00906" name="l00906"></a><span class="lineno">  906</span><span class="comment">   * machine governing the operation of the socket.</span></div>
<div class="line"><a id="l00907" name="l00907"></a><span class="lineno">  907</span><span class="comment">   *</span></div>
<div class="line"><a id="l00908" name="l00908"></a><span class="lineno">  908</span><span class="comment">   * @todo Peer_socket::Int_state will also include various states on way to a graceful close, once we implement that.</span></div>
<div class="line"><a id="l00909" name="l00909"></a><span class="lineno">  909</span><span class="comment">   */</span></div>
<div class="line"><a id="l00910" name="l00910"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a9537860c2c2a7380a45a525e5121880f">  910</a></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Peer__socket.html#a9537860c2c2a7380a45a525e5121880f">Int_state</a></div>
<div class="line"><a id="l00911" name="l00911"></a><span class="lineno">  911</span>  {<span class="comment"></span></div>
<div class="line"><a id="l00912" name="l00912"></a><span class="lineno">  912</span><span class="comment">    /// Closed (dead or new) socket.</span></div>
<div class="line"><a id="l00913" name="l00913"></a><span class="lineno">  913</span><span class="comment"></span>    S_CLOSED,</div>
<div class="line"><a id="l00914" name="l00914"></a><span class="lineno">  914</span><span class="comment"></span> </div>
<div class="line"><a id="l00915" name="l00915"></a><span class="lineno">  915</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00916" name="l00916"></a><span class="lineno">  916</span><span class="comment">     * Public state is OPEN+CONNECTING; user requested active connect; we sent SYN and are</span></div>
<div class="line"><a id="l00917" name="l00917"></a><span class="lineno">  917</span><span class="comment">     * awaiting response.</span></div>
<div class="line"><a id="l00918" name="l00918"></a><span class="lineno">  918</span><span class="comment">     */</span></div>
<div class="line"><a id="l00919" name="l00919"></a><span class="lineno">  919</span>    S_SYN_SENT,</div>
<div class="line"><a id="l00920" name="l00920"></a><span class="lineno">  920</span><span class="comment"></span> </div>
<div class="line"><a id="l00921" name="l00921"></a><span class="lineno">  921</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00922" name="l00922"></a><span class="lineno">  922</span><span class="comment">     * Public state is OPEN+CONNECTING; other side requested passive connect via SYN; we sent</span></div>
<div class="line"><a id="l00923" name="l00923"></a><span class="lineno">  923</span><span class="comment">     * SYN_ACK and are awaiting response.</span></div>
<div class="line"><a id="l00924" name="l00924"></a><span class="lineno">  924</span><span class="comment">     */</span></div>
<div class="line"><a id="l00925" name="l00925"></a><span class="lineno">  925</span>    S_SYN_RCVD,</div>
<div class="line"><a id="l00926" name="l00926"></a><span class="lineno">  926</span><span class="comment"></span> </div>
<div class="line"><a id="l00927" name="l00927"></a><span class="lineno">  927</span><span class="comment">    /// Public state is OPEN+CONNECTED; in our opinion the connection is established.</span></div>
<div class="line"><a id="l00928" name="l00928"></a><span class="lineno">  928</span><span class="comment"></span>    S_ESTABLISHED</div>
<div class="line"><a id="l00929" name="l00929"></a><span class="lineno">  929</span>  }; <span class="comment">// enum class Int_state</span></div>
<div class="line"><a id="l00930" name="l00930"></a><span class="lineno">  930</span> </div>
<div class="line"><a id="l00931" name="l00931"></a><span class="lineno">  931</span>  <span class="comment">// Friend of Peer_socket: For access to private alias Int_state.</span></div>
<div class="line"><a id="l00932" name="l00932"></a><span class="lineno">  932</span>  <span class="keyword">friend</span> std::ostream&amp; <a class="code hl_friend" href="classflow_1_1net__flow_1_1Peer__socket.html#a03ea7069aa4779abaf274989bd4c2fb6">operator&lt;&lt;</a>(std::ostream&amp; os, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Peer__socket.html#a9537860c2c2a7380a45a525e5121880f">Int_state</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#af982953b5136c1df488066eacc293a78">state</a>);</div>
<div class="line"><a id="l00933" name="l00933"></a><span class="lineno">  933</span> </div>
<div class="line"><a id="l00934" name="l00934"></a><span class="lineno">  934</span>  <span class="keyword">struct </span>Sent_packet;</div>
<div class="line"><a id="l00935" name="l00935"></a><span class="lineno">  935</span><span class="comment"></span> </div>
<div class="line"><a id="l00936" name="l00936"></a><span class="lineno">  936</span><span class="comment">  /// Short-hand for #m_snd_flying_pkts_by_sent_when type; see that data member.</span></div>
<div class="line"><a id="l00937" name="l00937"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ad10b3cd1d32b48cab8146ba4d07cb814">  937</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__map.html">Sent_pkt_by_sent_when_map</a> = <a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__map.html">util::Linked_hash_map&lt;Sequence_number, boost::shared_ptr&lt;Sent_packet&gt;</a>&gt;;</div>
<div class="line"><a id="l00938" name="l00938"></a><span class="lineno">  938</span><span class="comment"></span> </div>
<div class="line"><a id="l00939" name="l00939"></a><span class="lineno">  939</span><span class="comment">  /// Short-hand for #m_snd_flying_pkts_by_sent_when `const` iterator type.</span></div>
<div class="line"><a id="l00940" name="l00940"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ac974bdce3d2035d2af69078837f59482">  940</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#ac974bdce3d2035d2af69078837f59482">Sent_pkt_ordered_by_when_const_iter</a> = <a class="code hl_typedef" href="classflow_1_1util_1_1Linked__hash__map.html#a2b5383264c89ac63cc8827b18063f2ca">Sent_pkt_by_sent_when_map::const_iterator</a>;</div>
<div class="line"><a id="l00941" name="l00941"></a><span class="lineno">  941</span><span class="comment"></span> </div>
<div class="line"><a id="l00942" name="l00942"></a><span class="lineno">  942</span><span class="comment">  /// Short-hand for #m_snd_flying_pkts_by_sent_when iterator type.</span></div>
<div class="line"><a id="l00943" name="l00943"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ab7dc3b752b67295c82919c2f87aed60b">  943</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#ab7dc3b752b67295c82919c2f87aed60b">Sent_pkt_ordered_by_when_iter</a> = <a class="code hl_typedef" href="classflow_1_1util_1_1Linked__hash__map.html#a1f09f98b4089a8c3ffd0b7f732923b44">Sent_pkt_by_sent_when_map::iterator</a>;</div>
<div class="line"><a id="l00944" name="l00944"></a><span class="lineno">  944</span><span class="comment"></span> </div>
<div class="line"><a id="l00945" name="l00945"></a><span class="lineno">  945</span><span class="comment">  /// Short-hand for #m_snd_flying_pkts_by_seq_num type; see that data member.</span></div>
<div class="line"><a id="l00946" name="l00946"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a1958264af0c40f3c9c5769ddff4c9ade">  946</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a1958264af0c40f3c9c5769ddff4c9ade">Sent_pkt_by_seq_num_map</a> = std::map&lt;Sequence_number, Sent_pkt_ordered_by_when_iter&gt;;</div>
<div class="line"><a id="l00947" name="l00947"></a><span class="lineno">  947</span><span class="comment"></span> </div>
<div class="line"><a id="l00948" name="l00948"></a><span class="lineno">  948</span><span class="comment">  /// Short-hand for #m_snd_flying_pkts_by_seq_num `const` iterator type.</span></div>
<div class="line"><a id="l00949" name="l00949"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#abd6f3174914c3ec559954b4125f2f9dd">  949</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#abd6f3174914c3ec559954b4125f2f9dd">Sent_pkt_ordered_by_seq_const_iter</a> = Sent_pkt_by_seq_num_map::const_iterator;</div>
<div class="line"><a id="l00950" name="l00950"></a><span class="lineno">  950</span><span class="comment"></span> </div>
<div class="line"><a id="l00951" name="l00951"></a><span class="lineno">  951</span><span class="comment">  /// Short-hand for #m_snd_flying_pkts_by_seq_num iterator type.</span></div>
<div class="line"><a id="l00952" name="l00952"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a9320421e96ab89e6528da6a28b008709">  952</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a9320421e96ab89e6528da6a28b008709">Sent_pkt_ordered_by_seq_iter</a> = Sent_pkt_by_seq_num_map::iterator;</div>
<div class="line"><a id="l00953" name="l00953"></a><span class="lineno">  953</span> </div>
<div class="line"><a id="l00954" name="l00954"></a><span class="lineno">  954</span>  <span class="keyword">struct </span><a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html">Received_packet</a>;</div>
<div class="line"><a id="l00955" name="l00955"></a><span class="lineno">  955</span><span class="comment"></span> </div>
<div class="line"><a id="l00956" name="l00956"></a><span class="lineno">  956</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00957" name="l00957"></a><span class="lineno">  957</span><span class="comment">   * Short-hand for #m_rcv_packets_with_gaps type; see that data member.  `struct`s are stored via</span></div>
<div class="line"><a id="l00958" name="l00958"></a><span class="lineno">  958</span><span class="comment">   * shared pointers instead of as direct objects to minimize copying of potentially heavy-weight</span></div>
<div class="line"><a id="l00959" name="l00959"></a><span class="lineno">  959</span><span class="comment">   * data.  They are stored as shared pointers instead of as raw pointers to avoid having to</span></div>
<div class="line"><a id="l00960" name="l00960"></a><span class="lineno">  960</span><span class="comment">   * worry about `delete`.</span></div>
<div class="line"><a id="l00961" name="l00961"></a><span class="lineno">  961</span><span class="comment">   */</span></div>
<div class="line"><a id="l00962" name="l00962"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#addfc181f4d43ab816b2ede9216bf9331">  962</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#addfc181f4d43ab816b2ede9216bf9331">Recvd_pkt_map</a> = std::map&lt;Sequence_number, boost::shared_ptr&lt;Received_packet&gt;&gt;;</div>
<div class="line"><a id="l00963" name="l00963"></a><span class="lineno">  963</span><span class="comment"></span> </div>
<div class="line"><a id="l00964" name="l00964"></a><span class="lineno">  964</span><span class="comment">  /// Short-hand for #m_rcv_packets_with_gaps `const` iterator type.</span></div>
<div class="line"><a id="l00965" name="l00965"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ade41e13eb5176d833c7b1ea144612353">  965</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#ade41e13eb5176d833c7b1ea144612353">Recvd_pkt_const_iter</a> = Recvd_pkt_map::const_iterator;</div>
<div class="line"><a id="l00966" name="l00966"></a><span class="lineno">  966</span><span class="comment"></span> </div>
<div class="line"><a id="l00967" name="l00967"></a><span class="lineno">  967</span><span class="comment">  /// Short-hand for #m_rcv_packets_with_gaps iterator type.</span></div>
<div class="line"><a id="l00968" name="l00968"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#aaec992a7a14368623cc03c4382d71107">  968</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#aaec992a7a14368623cc03c4382d71107">Recvd_pkt_iter</a> = Recvd_pkt_map::iterator;</div>
<div class="line"><a id="l00969" name="l00969"></a><span class="lineno">  969</span> </div>
<div class="line"><a id="l00970" name="l00970"></a><span class="lineno">  970</span>  <span class="keyword">struct </span><a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html">Individual_ack</a>;</div>
<div class="line"><a id="l00971" name="l00971"></a><span class="lineno">  971</span><span class="comment"></span> </div>
<div class="line"><a id="l00972" name="l00972"></a><span class="lineno">  972</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00973" name="l00973"></a><span class="lineno">  973</span><span class="comment">   * Type used for #m_rcv_syn_rcvd_data_q.  Using `vector` because we only need `push_back()` and</span></div>
<div class="line"><a id="l00974" name="l00974"></a><span class="lineno">  974</span><span class="comment">   * iteration at the moment.  Using pointer to non-`const` instead of `const` because when we actually handle the</span></div>
<div class="line"><a id="l00975" name="l00975"></a><span class="lineno">  975</span><span class="comment">   * packet as received we will need to be able to modify the packet for performance (see</span></div>
<div class="line"><a id="l00976" name="l00976"></a><span class="lineno">  976</span><span class="comment">   * Node::handle_data_to_established(), when it transfers data to Receive buffer).</span></div>
<div class="line"><a id="l00977" name="l00977"></a><span class="lineno">  977</span><span class="comment">   */</span></div>
<div class="line"><a id="l00978" name="l00978"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a1869760d5cfc5c0d22665e5db88710e4">  978</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a1869760d5cfc5c0d22665e5db88710e4">Rcv_syn_rcvd_data_q</a> = std::vector&lt;boost::shared_ptr&lt;Data_packet&gt;&gt;;</div>
<div class="line"><a id="l00979" name="l00979"></a><span class="lineno">  979</span> </div>
<div class="line"><a id="l00980" name="l00980"></a><span class="lineno">  980</span>  <span class="comment">/* Methods: as few as possible.  Logic should reside in class Node as discussed (though</span></div>
<div class="line"><a id="l00981" name="l00981"></a><span class="lineno">  981</span><span class="comment">   * implementation may be in peer_socket.cpp).  See rationale in class Peer_socket</span></div>
<div class="line"><a id="l00982" name="l00982"></a><span class="lineno">  982</span><span class="comment">   * documentation header. */</span></div>
<div class="line"><a id="l00983" name="l00983"></a><span class="lineno">  983</span><span class="comment"></span> </div>
<div class="line"><a id="l00984" name="l00984"></a><span class="lineno">  984</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00985" name="l00985"></a><span class="lineno">  985</span><span class="comment">   * Non-template helper for template send() that forwards the send() logic to Node::send().  Would</span></div>
<div class="line"><a id="l00986" name="l00986"></a><span class="lineno">  986</span><span class="comment">   * be pointless to try to explain more here; see code and how it&#39;s used.  Anyway, this has to be</span></div>
<div class="line"><a id="l00987" name="l00987"></a><span class="lineno">  987</span><span class="comment">   * in this class.</span></div>
<div class="line"><a id="l00988" name="l00988"></a><span class="lineno">  988</span><span class="comment">   *</span></div>
<div class="line"><a id="l00989" name="l00989"></a><span class="lineno">  989</span><span class="comment">   * @param snd_buf_feed_func</span></div>
<div class="line"><a id="l00990" name="l00990"></a><span class="lineno">  990</span><span class="comment">   *        Function that will perform and return `m_snd_buf-&gt;feed(...)`.  See send().</span></div>
<div class="line"><a id="l00991" name="l00991"></a><span class="lineno">  991</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00992" name="l00992"></a><span class="lineno">  992</span><span class="comment">   *        See send().</span></div>
<div class="line"><a id="l00993" name="l00993"></a><span class="lineno">  993</span><span class="comment">   * @return Value to be returned by calling Node::send().</span></div>
<div class="line"><a id="l00994" name="l00994"></a><span class="lineno">  994</span><span class="comment">   */</span></div>
<div class="line"><a id="l00995" name="l00995"></a><span class="lineno">  995</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a83ba2b4c39555afad67932ea6ed39bbe">node_send</a>(<span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;<span class="keywordtype">size_t</span> (<span class="keywordtype">size_t</span> max_data_size)&gt;&amp; snd_buf_feed_func,</div>
<div class="line"><a id="l00996" name="l00996"></a><span class="lineno">  996</span>                   <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l00997" name="l00997"></a><span class="lineno">  997</span><span class="comment"></span> </div>
<div class="line"><a id="l00998" name="l00998"></a><span class="lineno">  998</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00999" name="l00999"></a><span class="lineno">  999</span><span class="comment">   * Same as sync_send() but uses a #Fine_clock-based #Fine_duration non-template type for</span></div>
<div class="line"><a id="l01000" name="l01000"></a><span class="lineno"> 1000</span><span class="comment">   * implementation convenience and to avoid code bloat to specify timeout.</span></div>
<div class="line"><a id="l01001" name="l01001"></a><span class="lineno"> 1001</span><span class="comment">   *</span></div>
<div class="line"><a id="l01002" name="l01002"></a><span class="lineno"> 1002</span><span class="comment">   * @tparam Const_buffer_sequence</span></div>
<div class="line"><a id="l01003" name="l01003"></a><span class="lineno"> 1003</span><span class="comment">   *         See sync_send().</span></div>
<div class="line"><a id="l01004" name="l01004"></a><span class="lineno"> 1004</span><span class="comment">   * @param data</span></div>
<div class="line"><a id="l01005" name="l01005"></a><span class="lineno"> 1005</span><span class="comment">   *        See sync_send().</span></div>
<div class="line"><a id="l01006" name="l01006"></a><span class="lineno"> 1006</span><span class="comment">   * @param wait_until</span></div>
<div class="line"><a id="l01007" name="l01007"></a><span class="lineno"> 1007</span><span class="comment">   *        See `sync_send(timeout)`.  This is the absolute time point corresponding to that.</span></div>
<div class="line"><a id="l01008" name="l01008"></a><span class="lineno"> 1008</span><span class="comment">   *        `&quot;duration&lt;Rep, Period&gt;::max()&quot;` maps to the value `Fine_time_pt()` (Epoch) for this argument.</span></div>
<div class="line"><a id="l01009" name="l01009"></a><span class="lineno"> 1009</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l01010" name="l01010"></a><span class="lineno"> 1010</span><span class="comment">   *        See sync_send().</span></div>
<div class="line"><a id="l01011" name="l01011"></a><span class="lineno"> 1011</span><span class="comment">   * @return See sync_send().</span></div>
<div class="line"><a id="l01012" name="l01012"></a><span class="lineno"> 1012</span><span class="comment">   */</span></div>
<div class="line"><a id="l01013" name="l01013"></a><span class="lineno"> 1013</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Const_buffer_sequence&gt;</div>
<div class="line"><a id="l01014" name="l01014"></a><span class="lineno"> 1014</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a3f1a802024549a59978a53343b09a86d">sync_send_impl</a>(<span class="keyword">const</span> Const_buffer_sequence&amp; data, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until,</div>
<div class="line"><a id="l01015" name="l01015"></a><span class="lineno"> 1015</span>                        <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l01016" name="l01016"></a><span class="lineno"> 1016</span><span class="comment"></span> </div>
<div class="line"><a id="l01017" name="l01017"></a><span class="lineno"> 1017</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01018" name="l01018"></a><span class="lineno"> 1018</span><span class="comment">   * Helper similar to sync_send_impl() but for the `nullptr_t` versions of `sync_send()`.</span></div>
<div class="line"><a id="l01019" name="l01019"></a><span class="lineno"> 1019</span><span class="comment">   *</span></div>
<div class="line"><a id="l01020" name="l01020"></a><span class="lineno"> 1020</span><span class="comment">   * @param wait_until</span></div>
<div class="line"><a id="l01021" name="l01021"></a><span class="lineno"> 1021</span><span class="comment">   *        See sync_send_impl().</span></div>
<div class="line"><a id="l01022" name="l01022"></a><span class="lineno"> 1022</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l01023" name="l01023"></a><span class="lineno"> 1023</span><span class="comment">   *        See sync_send_impl().</span></div>
<div class="line"><a id="l01024" name="l01024"></a><span class="lineno"> 1024</span><span class="comment">   * @return See `sync_send(nullptr_t)`.  `true` if and only if Writable status successfuly reached in time.</span></div>
<div class="line"><a id="l01025" name="l01025"></a><span class="lineno"> 1025</span><span class="comment">   */</span></div>
<div class="line"><a id="l01026" name="l01026"></a><span class="lineno"> 1026</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a15ba1d4af6d4e3fcab9534a307c00595">sync_send_reactor_pattern_impl</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l01027" name="l01027"></a><span class="lineno"> 1027</span><span class="comment"></span> </div>
<div class="line"><a id="l01028" name="l01028"></a><span class="lineno"> 1028</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01029" name="l01029"></a><span class="lineno"> 1029</span><span class="comment">   * This is to sync_send() as node_send() is to send().</span></div>
<div class="line"><a id="l01030" name="l01030"></a><span class="lineno"> 1030</span><span class="comment">   *</span></div>
<div class="line"><a id="l01031" name="l01031"></a><span class="lineno"> 1031</span><span class="comment">   * @param snd_buf_feed_func_or_empty</span></div>
<div class="line"><a id="l01032" name="l01032"></a><span class="lineno"> 1032</span><span class="comment">   *        See node_send().  Additionally, if this is `.empty()` then `nullptr_t` a/k/a &quot;reactor pattern&quot; mode is</span></div>
<div class="line"><a id="l01033" name="l01033"></a><span class="lineno"> 1033</span><span class="comment">   *        engaged.</span></div>
<div class="line"><a id="l01034" name="l01034"></a><span class="lineno"> 1034</span><span class="comment">   * @param wait_until</span></div>
<div class="line"><a id="l01035" name="l01035"></a><span class="lineno"> 1035</span><span class="comment">   *        See sync_send_impl().</span></div>
<div class="line"><a id="l01036" name="l01036"></a><span class="lineno"> 1036</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l01037" name="l01037"></a><span class="lineno"> 1037</span><span class="comment">   *        See sync_send().</span></div>
<div class="line"><a id="l01038" name="l01038"></a><span class="lineno"> 1038</span><span class="comment">   * @return See sync_send().</span></div>
<div class="line"><a id="l01039" name="l01039"></a><span class="lineno"> 1039</span><span class="comment">   */</span></div>
<div class="line"><a id="l01040" name="l01040"></a><span class="lineno"> 1040</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a34e2c7dfb5596269a6f86a716015f1a6">node_sync_send</a>(<span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;<span class="keywordtype">size_t</span> (<span class="keywordtype">size_t</span> max_data_size)&gt;&amp; snd_buf_feed_func_or_empty,</div>
<div class="line"><a id="l01041" name="l01041"></a><span class="lineno"> 1041</span>                        <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until,</div>
<div class="line"><a id="l01042" name="l01042"></a><span class="lineno"> 1042</span>                        <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l01043" name="l01043"></a><span class="lineno"> 1043</span><span class="comment"></span> </div>
<div class="line"><a id="l01044" name="l01044"></a><span class="lineno"> 1044</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01045" name="l01045"></a><span class="lineno"> 1045</span><span class="comment">   * Non-template helper for template receive() that forwards the receive() logic to</span></div>
<div class="line"><a id="l01046" name="l01046"></a><span class="lineno"> 1046</span><span class="comment">   * Node::receive().  Would be pointless to try to explain more here; see code and how it&#39;s used.</span></div>
<div class="line"><a id="l01047" name="l01047"></a><span class="lineno"> 1047</span><span class="comment">   * Anyway, this has to be in this class.</span></div>
<div class="line"><a id="l01048" name="l01048"></a><span class="lineno"> 1048</span><span class="comment">   *</span></div>
<div class="line"><a id="l01049" name="l01049"></a><span class="lineno"> 1049</span><span class="comment">   * @param rcv_buf_consume_func</span></div>
<div class="line"><a id="l01050" name="l01050"></a><span class="lineno"> 1050</span><span class="comment">   *        Function that will perform and return `m_rcv_buf-&gt;consume(...)`.  See receive().</span></div>
<div class="line"><a id="l01051" name="l01051"></a><span class="lineno"> 1051</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l01052" name="l01052"></a><span class="lineno"> 1052</span><span class="comment">   *        See receive().</span></div>
<div class="line"><a id="l01053" name="l01053"></a><span class="lineno"> 1053</span><span class="comment">   * @return Value to be returned by calling Node::receive().</span></div>
<div class="line"><a id="l01054" name="l01054"></a><span class="lineno"> 1054</span><span class="comment">   */</span></div>
<div class="line"><a id="l01055" name="l01055"></a><span class="lineno"> 1055</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#af3ac1b0b3c9b1c3a5ec246148595c657">node_receive</a>(<span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;<span class="keywordtype">size_t</span> ()&gt;&amp; rcv_buf_consume_func,</div>
<div class="line"><a id="l01056" name="l01056"></a><span class="lineno"> 1056</span>                      <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l01057" name="l01057"></a><span class="lineno"> 1057</span><span class="comment"></span> </div>
<div class="line"><a id="l01058" name="l01058"></a><span class="lineno"> 1058</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01059" name="l01059"></a><span class="lineno"> 1059</span><span class="comment">   * Same as sync_receive() but uses a #Fine_clock-based #Fine_duration non-template type</span></div>
<div class="line"><a id="l01060" name="l01060"></a><span class="lineno"> 1060</span><span class="comment">   * for implementation convenience and to avoid code bloat to specify timeout.</span></div>
<div class="line"><a id="l01061" name="l01061"></a><span class="lineno"> 1061</span><span class="comment">   *</span></div>
<div class="line"><a id="l01062" name="l01062"></a><span class="lineno"> 1062</span><span class="comment">   * @tparam Block_sequence</span></div>
<div class="line"><a id="l01063" name="l01063"></a><span class="lineno"> 1063</span><span class="comment">   *         See sync_receive().</span></div>
<div class="line"><a id="l01064" name="l01064"></a><span class="lineno"> 1064</span><span class="comment">   * @param target</span></div>
<div class="line"><a id="l01065" name="l01065"></a><span class="lineno"> 1065</span><span class="comment">   *        See sync_receive().</span></div>
<div class="line"><a id="l01066" name="l01066"></a><span class="lineno"> 1066</span><span class="comment">   * @param wait_until</span></div>
<div class="line"><a id="l01067" name="l01067"></a><span class="lineno"> 1067</span><span class="comment">   *        See `sync_receive(timeout)`.  This is the absolute time point corresponding to that.</span></div>
<div class="line"><a id="l01068" name="l01068"></a><span class="lineno"> 1068</span><span class="comment">   *        `&quot;duration&lt;Rep, Period&gt;::max()&quot;` maps to the value `Fine_time_pt()` (Epoch) for this argument.</span></div>
<div class="line"><a id="l01069" name="l01069"></a><span class="lineno"> 1069</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l01070" name="l01070"></a><span class="lineno"> 1070</span><span class="comment">   *        See sync_receive().</span></div>
<div class="line"><a id="l01071" name="l01071"></a><span class="lineno"> 1071</span><span class="comment">   * @return See sync_receive().</span></div>
<div class="line"><a id="l01072" name="l01072"></a><span class="lineno"> 1072</span><span class="comment">   */</span></div>
<div class="line"><a id="l01073" name="l01073"></a><span class="lineno"> 1073</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Mutable_buffer_sequence&gt;</div>
<div class="line"><a id="l01074" name="l01074"></a><span class="lineno"> 1074</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#ad29f61b9885b10ddc3846cdae0560518">sync_receive_impl</a>(<span class="keyword">const</span> Mutable_buffer_sequence&amp; target,</div>
<div class="line"><a id="l01075" name="l01075"></a><span class="lineno"> 1075</span>                           <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l01076" name="l01076"></a><span class="lineno"> 1076</span><span class="comment"></span> </div>
<div class="line"><a id="l01077" name="l01077"></a><span class="lineno"> 1077</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01078" name="l01078"></a><span class="lineno"> 1078</span><span class="comment">   * Helper similar to sync_receive_impl() but for the `nullptr_t` versions of `sync_receive()`.</span></div>
<div class="line"><a id="l01079" name="l01079"></a><span class="lineno"> 1079</span><span class="comment">   *</span></div>
<div class="line"><a id="l01080" name="l01080"></a><span class="lineno"> 1080</span><span class="comment">   * @param wait_until</span></div>
<div class="line"><a id="l01081" name="l01081"></a><span class="lineno"> 1081</span><span class="comment">   *        See sync_receive_impl().</span></div>
<div class="line"><a id="l01082" name="l01082"></a><span class="lineno"> 1082</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l01083" name="l01083"></a><span class="lineno"> 1083</span><span class="comment">   *        See sync_receive_impl().</span></div>
<div class="line"><a id="l01084" name="l01084"></a><span class="lineno"> 1084</span><span class="comment">   * @return See `sync_receive(nullptr_t)`.  `true` if and only if Readable status successfuly reached in time.</span></div>
<div class="line"><a id="l01085" name="l01085"></a><span class="lineno"> 1085</span><span class="comment">   */</span></div>
<div class="line"><a id="l01086" name="l01086"></a><span class="lineno"> 1086</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a1a2eccfa314a397c12259f414ef6798c">sync_receive_reactor_pattern_impl</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l01087" name="l01087"></a><span class="lineno"> 1087</span><span class="comment"></span> </div>
<div class="line"><a id="l01088" name="l01088"></a><span class="lineno"> 1088</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01089" name="l01089"></a><span class="lineno"> 1089</span><span class="comment">   * This is to sync_receive() as node_receive() is to receive().</span></div>
<div class="line"><a id="l01090" name="l01090"></a><span class="lineno"> 1090</span><span class="comment">   *</span></div>
<div class="line"><a id="l01091" name="l01091"></a><span class="lineno"> 1091</span><span class="comment">   * @param rcv_buf_consume_func_or_empty</span></div>
<div class="line"><a id="l01092" name="l01092"></a><span class="lineno"> 1092</span><span class="comment">   *        See node_receive().  Additionally, if this is `.empty()` then `nullptr_t` a/k/a &quot;reactor pattern&quot; mode is</span></div>
<div class="line"><a id="l01093" name="l01093"></a><span class="lineno"> 1093</span><span class="comment">   *        engaged.</span></div>
<div class="line"><a id="l01094" name="l01094"></a><span class="lineno"> 1094</span><span class="comment">   * @param wait_until</span></div>
<div class="line"><a id="l01095" name="l01095"></a><span class="lineno"> 1095</span><span class="comment">   *        See sync_receive_impl().</span></div>
<div class="line"><a id="l01096" name="l01096"></a><span class="lineno"> 1096</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l01097" name="l01097"></a><span class="lineno"> 1097</span><span class="comment">   *        See sync_receive().</span></div>
<div class="line"><a id="l01098" name="l01098"></a><span class="lineno"> 1098</span><span class="comment">   * @return See sync_receive().</span></div>
<div class="line"><a id="l01099" name="l01099"></a><span class="lineno"> 1099</span><span class="comment">   */</span></div>
<div class="line"><a id="l01100" name="l01100"></a><span class="lineno"> 1100</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a8abde92d5189bf2a058fe8741789f814">node_sync_receive</a>(<span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;<span class="keywordtype">size_t</span> ()&gt;&amp; rcv_buf_consume_func_or_empty,</div>
<div class="line"><a id="l01101" name="l01101"></a><span class="lineno"> 1101</span>                           <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until,</div>
<div class="line"><a id="l01102" name="l01102"></a><span class="lineno"> 1102</span>                           <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l01103" name="l01103"></a><span class="lineno"> 1103</span><span class="comment"></span> </div>
<div class="line"><a id="l01104" name="l01104"></a><span class="lineno"> 1104</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01105" name="l01105"></a><span class="lineno"> 1105</span><span class="comment">   * Analogous to Node::opt() but for per-socket options.  See that method.</span></div>
<div class="line"><a id="l01106" name="l01106"></a><span class="lineno"> 1106</span><span class="comment">   *</span></div>
<div class="line"><a id="l01107" name="l01107"></a><span class="lineno"> 1107</span><span class="comment">   * Do NOT read option values without opt().</span></div>
<div class="line"><a id="l01108" name="l01108"></a><span class="lineno"> 1108</span><span class="comment">   *</span></div>
<div class="line"><a id="l01109" name="l01109"></a><span class="lineno"> 1109</span><span class="comment">   * @tparam Opt_type</span></div>
<div class="line"><a id="l01110" name="l01110"></a><span class="lineno"> 1110</span><span class="comment">   *         The type of the option data member.</span></div>
<div class="line"><a id="l01111" name="l01111"></a><span class="lineno"> 1111</span><span class="comment">   * @param opt_val_ref</span></div>
<div class="line"><a id="l01112" name="l01112"></a><span class="lineno"> 1112</span><span class="comment">   *        A reference (important!) to the value you want; this may be either a data member of</span></div>
<div class="line"><a id="l01113" name="l01113"></a><span class="lineno"> 1113</span><span class="comment">   *        this-&gt;m_opts or the entire this-&gt;m_opts itself.</span></div>
<div class="line"><a id="l01114" name="l01114"></a><span class="lineno"> 1114</span><span class="comment">   * @return A copy of the value at the given reference.</span></div>
<div class="line"><a id="l01115" name="l01115"></a><span class="lineno"> 1115</span><span class="comment">   */</span></div>
<div class="line"><a id="l01116" name="l01116"></a><span class="lineno"> 1116</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Opt_type&gt;</div>
<div class="line"><a id="l01117" name="l01117"></a><span class="lineno"> 1117</span>  Opt_type <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#accf6d724ed1f145716ae3d4567f582f3">opt</a>(<span class="keyword">const</span> Opt_type&amp; opt_val_ref) <span class="keyword">const</span>;</div>
<div class="line"><a id="l01118" name="l01118"></a><span class="lineno"> 1118</span><span class="comment"></span> </div>
<div class="line"><a id="l01119" name="l01119"></a><span class="lineno"> 1119</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01120" name="l01120"></a><span class="lineno"> 1120</span><span class="comment">   * Returns the smallest multiple of max_block_size() that is &gt;= the given option value, optionally</span></div>
<div class="line"><a id="l01121" name="l01121"></a><span class="lineno"> 1121</span><span class="comment">   * first inflated by a certain %.  The intended use case is to obtain a Send of Receive buffer max</span></div>
<div class="line"><a id="l01122" name="l01122"></a><span class="lineno"> 1122</span><span class="comment">   * size that is about equal to the user-specified (or otherwise obtained) value, in bytes, but is</span></div>
<div class="line"><a id="l01123" name="l01123"></a><span class="lineno"> 1123</span><span class="comment">   * a multiple of max-block-size -- to prevent fragmenting max-block-size-sized chunks of data unnecessarily -- and</span></div>
<div class="line"><a id="l01124" name="l01124"></a><span class="lineno"> 1124</span><span class="comment">   * to possibly inflate that value by a certain percentage for subtle flow control reasons.</span></div>
<div class="line"><a id="l01125" name="l01125"></a><span class="lineno"> 1125</span><span class="comment">   *</span></div>
<div class="line"><a id="l01126" name="l01126"></a><span class="lineno"> 1126</span><span class="comment">   * @param opt_val_ref</span></div>
<div class="line"><a id="l01127" name="l01127"></a><span class="lineno"> 1127</span><span class="comment">   *        A reference to a `size_t`-sized socket option, as would be passed to opt().  See opt().</span></div>
<div class="line"><a id="l01128" name="l01128"></a><span class="lineno"> 1128</span><span class="comment">   *        This is the starting value.</span></div>
<div class="line"><a id="l01129" name="l01129"></a><span class="lineno"> 1129</span><span class="comment">   * @param inflate_pct_val_ptr</span></div>
<div class="line"><a id="l01130" name="l01130"></a><span class="lineno"> 1130</span><span class="comment">   *        A pointer to an `unsigned int`-sized socket option, as would be passed to opt().  See</span></div>
<div class="line"><a id="l01131" name="l01131"></a><span class="lineno"> 1131</span><span class="comment">   *        opt().  This is the % by which to inflate opt_val_ref before rounding up to nearest</span></div>
<div class="line"><a id="l01132" name="l01132"></a><span class="lineno"> 1132</span><span class="comment">   *        max_block_size() multiple.  If null, the % is assumed to be 0.</span></div>
<div class="line"><a id="l01133" name="l01133"></a><span class="lineno"> 1133</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l01134" name="l01134"></a><span class="lineno"> 1134</span><span class="comment">   */</span></div>
<div class="line"><a id="l01135" name="l01135"></a><span class="lineno"> 1135</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a102b78eaac9c8add512238ec5f26fcfc">max_block_size_multiple</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span>&amp; opt_val_ref,</div>
<div class="line"><a id="l01136" name="l01136"></a><span class="lineno"> 1136</span>                                 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* inflate_pct_val_ptr = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l01137" name="l01137"></a><span class="lineno"> 1137</span><span class="comment"></span> </div>
<div class="line"><a id="l01138" name="l01138"></a><span class="lineno"> 1138</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01139" name="l01139"></a><span class="lineno"> 1139</span><span class="comment">   * Whether retransmission is enabled on this connection.  Short-hand for appropriate opt() call.</span></div>
<div class="line"><a id="l01140" name="l01140"></a><span class="lineno"> 1140</span><span class="comment">   * Note this always returns the same value for a given object.</span></div>
<div class="line"><a id="l01141" name="l01141"></a><span class="lineno"> 1141</span><span class="comment">   *</span></div>
<div class="line"><a id="l01142" name="l01142"></a><span class="lineno"> 1142</span><span class="comment">   * @return Ditto.</span></div>
<div class="line"><a id="l01143" name="l01143"></a><span class="lineno"> 1143</span><span class="comment">   */</span></div>
<div class="line"><a id="l01144" name="l01144"></a><span class="lineno"> 1144</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a89d852e3722532d75006b024714a5cef">rexmit_on</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l01145" name="l01145"></a><span class="lineno"> 1145</span><span class="comment"></span> </div>
<div class="line"><a id="l01146" name="l01146"></a><span class="lineno"> 1146</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01147" name="l01147"></a><span class="lineno"> 1147</span><span class="comment">   * Helper that is equivalent to Node::ensure_sock_open(this, err_code).  Used by templated</span></div>
<div class="line"><a id="l01148" name="l01148"></a><span class="lineno"> 1148</span><span class="comment">   * methods which must be defined in this header file, which means they cannot access Node members</span></div>
<div class="line"><a id="l01149" name="l01149"></a><span class="lineno"> 1149</span><span class="comment">   * directly, as Node is an incomplete type.</span></div>
<div class="line"><a id="l01150" name="l01150"></a><span class="lineno"> 1150</span><span class="comment">   *</span></div>
<div class="line"><a id="l01151" name="l01151"></a><span class="lineno"> 1151</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l01152" name="l01152"></a><span class="lineno"> 1152</span><span class="comment">   *        See Node::ensure_sock_open().</span></div>
<div class="line"><a id="l01153" name="l01153"></a><span class="lineno"> 1153</span><span class="comment">   * @return See Node::ensure_sock_open().</span></div>
<div class="line"><a id="l01154" name="l01154"></a><span class="lineno"> 1154</span><span class="comment">   */</span></div>
<div class="line"><a id="l01155" name="l01155"></a><span class="lineno"> 1155</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#ac7cbefb99ae173bd5f355f5d082564ce">ensure_open</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code) <span class="keyword">const</span>;</div>
<div class="line"><a id="l01156" name="l01156"></a><span class="lineno"> 1156</span><span class="comment"></span> </div>
<div class="line"><a id="l01157" name="l01157"></a><span class="lineno"> 1157</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01158" name="l01158"></a><span class="lineno"> 1158</span><span class="comment">   * Helper that, given a byte count, returns a string with that byte count and the number of</span></div>
<div class="line"><a id="l01159" name="l01159"></a><span class="lineno"> 1159</span><span class="comment">   * max_block_size()-size blocks that can fit within it (rounded down).</span></div>
<div class="line"><a id="l01160" name="l01160"></a><span class="lineno"> 1160</span><span class="comment">   *</span></div>
<div class="line"><a id="l01161" name="l01161"></a><span class="lineno"> 1161</span><span class="comment">   * @param bytes</span></div>
<div class="line"><a id="l01162" name="l01162"></a><span class="lineno"> 1162</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l01163" name="l01163"></a><span class="lineno"> 1163</span><span class="comment">   */</span></div>
<div class="line"><a id="l01164" name="l01164"></a><span class="lineno"> 1164</span>  std::string <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#acd100a3c02fad5d9e00fcbc1f645f116">bytes_blocks_str</a>(<span class="keywordtype">size_t</span> bytes) <span class="keyword">const</span>;</div>
<div class="line"><a id="l01165" name="l01165"></a><span class="lineno"> 1165</span> </div>
<div class="line"><a id="l01166" name="l01166"></a><span class="lineno"> 1166</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l01167" name="l01167"></a><span class="lineno"> 1167</span><span class="comment"></span> </div>
<div class="line"><a id="l01168" name="l01168"></a><span class="lineno"> 1168</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01169" name="l01169"></a><span class="lineno"> 1169</span><span class="comment">   * This socket&#39;s per-socket set of options.  Initialized at construction; can be subsequently</span></div>
<div class="line"><a id="l01170" name="l01170"></a><span class="lineno"> 1170</span><span class="comment">   * modified by set_options(), although only the dynamic members of this may be modified.</span></div>
<div class="line"><a id="l01171" name="l01171"></a><span class="lineno"> 1171</span><span class="comment">   *</span></div>
<div class="line"><a id="l01172" name="l01172"></a><span class="lineno"> 1172</span><span class="comment">   * Accessed from thread W and user thread U != W.  Protected by #m_opts_mutex.  When reading, do</span></div>
<div class="line"><a id="l01173" name="l01173"></a><span class="lineno"> 1173</span><span class="comment">   * NOT access without locking (which is encapsulated in opt()).</span></div>
<div class="line"><a id="l01174" name="l01174"></a><span class="lineno"> 1174</span><span class="comment">   */</span></div>
<div class="line"><a id="l01175" name="l01175"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ad59c09f34003873a3c207cc590236773"> 1175</a></span>  <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ad59c09f34003873a3c207cc590236773">m_opts</a>;</div>
<div class="line"><a id="l01176" name="l01176"></a><span class="lineno"> 1176</span><span class="comment"></span> </div>
<div class="line"><a id="l01177" name="l01177"></a><span class="lineno"> 1177</span><span class="comment">  /// The mutex protecting #m_opts.</span></div>
<div class="line"><a id="l01178" name="l01178"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#addfbe1487c621d4a9c464aec61bc108a"> 1178</a></span><span class="comment"></span>  <span class="keyword">mutable</span> <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a1e1379f9a0269d6990f26bf1da045657">Options_mutex</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#addfbe1487c621d4a9c464aec61bc108a">m_opts_mutex</a>;</div>
<div class="line"><a id="l01179" name="l01179"></a><span class="lineno"> 1179</span><span class="comment"></span> </div>
<div class="line"><a id="l01180" name="l01180"></a><span class="lineno"> 1180</span><span class="comment">  /// `true` if we connect() to server; `false` if we are to be/are `accept()`ed.  Should be set once and not modified.</span></div>
<div class="line"><a id="l01181" name="l01181"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a288ccfc742d6982c4059d82500397874"> 1181</a></span><span class="comment"></span>  <span class="keywordtype">bool</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a288ccfc742d6982c4059d82500397874">m_active_connect</a>;</div>
<div class="line"><a id="l01182" name="l01182"></a><span class="lineno"> 1182</span><span class="comment"></span> </div>
<div class="line"><a id="l01183" name="l01183"></a><span class="lineno"> 1183</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01184" name="l01184"></a><span class="lineno"> 1184</span><span class="comment">   * See state().  Should be set before user gets access to `*this`.  Must not be modified by non-W threads after that.</span></div>
<div class="line"><a id="l01185" name="l01185"></a><span class="lineno"> 1185</span><span class="comment">   *</span></div>
<div class="line"><a id="l01186" name="l01186"></a><span class="lineno"> 1186</span><span class="comment">   * Accessed from thread W and user threads U != W (in state() and others).  Must be protected</span></div>
<div class="line"><a id="l01187" name="l01187"></a><span class="lineno"> 1187</span><span class="comment">   * by mutex.</span></div>
<div class="line"><a id="l01188" name="l01188"></a><span class="lineno"> 1188</span><span class="comment">   */</span></div>
<div class="line"><a id="l01189" name="l01189"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a05a765055fd54412c63e57e43697f1bc"> 1189</a></span>  <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Peer__socket.html#a6a9bb727c8982f24bcf978c10c2c7345">State</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a05a765055fd54412c63e57e43697f1bc">m_state</a>;</div>
<div class="line"><a id="l01190" name="l01190"></a><span class="lineno"> 1190</span><span class="comment"></span> </div>
<div class="line"><a id="l01191" name="l01191"></a><span class="lineno"> 1191</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01192" name="l01192"></a><span class="lineno"> 1192</span><span class="comment">   * See state().  Should be set before user gets access to `*this`.  Must not be modified by non-W</span></div>
<div class="line"><a id="l01193" name="l01193"></a><span class="lineno"> 1193</span><span class="comment">   * threads after that.</span></div>
<div class="line"><a id="l01194" name="l01194"></a><span class="lineno"> 1194</span><span class="comment">   *</span></div>
<div class="line"><a id="l01195" name="l01195"></a><span class="lineno"> 1195</span><span class="comment">   * Accessed from thread W and user threads U != W (in state() and others).  Must be protected by</span></div>
<div class="line"><a id="l01196" name="l01196"></a><span class="lineno"> 1196</span><span class="comment">   * mutex.</span></div>
<div class="line"><a id="l01197" name="l01197"></a><span class="lineno"> 1197</span><span class="comment">   */</span></div>
<div class="line"><a id="l01198" name="l01198"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ae5d47460784cc20c9e44237edffaac95"> 1198</a></span>  <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Peer__socket.html#a6f48d01d1269c9d4260d972baa40e548">Open_sub_state</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ae5d47460784cc20c9e44237edffaac95">m_open_sub_state</a>;</div>
<div class="line"><a id="l01199" name="l01199"></a><span class="lineno"> 1199</span><span class="comment"></span> </div>
<div class="line"><a id="l01200" name="l01200"></a><span class="lineno"> 1200</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01201" name="l01201"></a><span class="lineno"> 1201</span><span class="comment">   * See node().  Should be set before user gets access to `*this` and not changed, except to null when</span></div>
<div class="line"><a id="l01202" name="l01202"></a><span class="lineno"> 1202</span><span class="comment">   * state is State::S_CLOSED.  Must not be modified by non-W threads.</span></div>
<div class="line"><a id="l01203" name="l01203"></a><span class="lineno"> 1203</span><span class="comment">   *</span></div>
<div class="line"><a id="l01204" name="l01204"></a><span class="lineno"> 1204</span><span class="comment">   * Invariant: `x-&gt;node() == y` if and only if `y-&gt;m_socks` contains `x`; otherwise `!x-&gt;node()`.</span></div>
<div class="line"><a id="l01205" name="l01205"></a><span class="lineno"> 1205</span><span class="comment">   * The invariant must hold by the end of the execution of any thread W boost.asio handler (but</span></div>
<div class="line"><a id="l01206" name="l01206"></a><span class="lineno"> 1206</span><span class="comment">   * not necessarily at all points within that handler, or generally).</span></div>
<div class="line"><a id="l01207" name="l01207"></a><span class="lineno"> 1207</span><span class="comment">   *</span></div>
<div class="line"><a id="l01208" name="l01208"></a><span class="lineno"> 1208</span><span class="comment">   * Accessed from thread W and user threads U != W (in node() and others).  Must be protected by</span></div>
<div class="line"><a id="l01209" name="l01209"></a><span class="lineno"> 1209</span><span class="comment">   * mutex.</span></div>
<div class="line"><a id="l01210" name="l01210"></a><span class="lineno"> 1210</span><span class="comment">   *</span></div>
<div class="line"><a id="l01211" name="l01211"></a><span class="lineno"> 1211</span><span class="comment">   * @todo `boost::weak_ptr&lt;Node&gt;` would be ideal for this, but of course then Node would have to</span></div>
<div class="line"><a id="l01212" name="l01212"></a><span class="lineno"> 1212</span><span class="comment">   * (only?) be available via shared_ptr&lt;&gt;.</span></div>
<div class="line"><a id="l01213" name="l01213"></a><span class="lineno"> 1213</span><span class="comment">   */</span></div>
<div class="line"><a id="l01214" name="l01214"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a36ab27af6886c7699f9965a5eb296cd6"> 1214</a></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">Node</a>* <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a36ab27af6886c7699f9965a5eb296cd6">m_node</a>;</div>
<div class="line"><a id="l01215" name="l01215"></a><span class="lineno"> 1215</span><span class="comment"></span> </div>
<div class="line"><a id="l01216" name="l01216"></a><span class="lineno"> 1216</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01217" name="l01217"></a><span class="lineno"> 1217</span><span class="comment">   * For sockets that come a Server_socket, this is the inverse of Server_socket::m_connecting_socks: it is</span></div>
<div class="line"><a id="l01218" name="l01218"></a><span class="lineno"> 1218</span><span class="comment">   * the Server_socket from which this Peer_socket will be Server_socket::accept()ed (if that succeeds); or null if</span></div>
<div class="line"><a id="l01219" name="l01219"></a><span class="lineno"> 1219</span><span class="comment">   * this is an actively-connecting Peer_socket or has already been `accept()`ed.</span></div>
<div class="line"><a id="l01220" name="l01220"></a><span class="lineno"> 1220</span><span class="comment">   *</span></div>
<div class="line"><a id="l01221" name="l01221"></a><span class="lineno"> 1221</span><span class="comment">   * More formally, this is null if #m_active_connect; null if not the case but already accept()ed; and otherwise:</span></div>
<div class="line"><a id="l01222" name="l01222"></a><span class="lineno"> 1222</span><span class="comment">   * `((y-&gt;m_connecting_socks contains x) || (y-&gt;m_unaccepted_socks contains x))` if and only if</span></div>
<div class="line"><a id="l01223" name="l01223"></a><span class="lineno"> 1223</span><span class="comment">   * `x-&gt;m_originating_serv == y`.  That is, for a socket in state Int_state::S_SYN_RCVD, or in state</span></div>
<div class="line"><a id="l01224" name="l01224"></a><span class="lineno"> 1224</span><span class="comment">   * Int_state::S_ESTABLISHED, but before being accept()ed by the user, this is the server socket that spawned this</span></div>
<div class="line"><a id="l01225" name="l01225"></a><span class="lineno"> 1225</span><span class="comment">   * peer socket.</span></div>
<div class="line"><a id="l01226" name="l01226"></a><span class="lineno"> 1226</span><span class="comment">   *</span></div>
<div class="line"><a id="l01227" name="l01227"></a><span class="lineno"> 1227</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l01228" name="l01228"></a><span class="lineno"> 1228</span><span class="comment">   * This can be write-accessed simultaneously by thread W (e.g., when closing a</span></div>
<div class="line"><a id="l01229" name="l01229"></a><span class="lineno"> 1229</span><span class="comment">   * socket before it is accepted) and a user thread U != W (in Server_socket::accept()).  It is</span></div>
<div class="line"><a id="l01230" name="l01230"></a><span class="lineno"> 1230</span><span class="comment">   * thus protected by a mutex -- but it&#39;s Server_socket::m_mutex, not Peer_socket::m_mutex.  I</span></div>
<div class="line"><a id="l01231" name="l01231"></a><span class="lineno"> 1231</span><span class="comment">   * know it&#39;s weird, but it makes sense.  Basically Server_socket::m_unaccepted_socks and</span></div>
<div class="line"><a id="l01232" name="l01232"></a><span class="lineno"> 1232</span><span class="comment">   * Server_socket::m_originating_serv -- for each element of `m_unaccepted_socks` -- are modified together</span></div>
<div class="line"><a id="l01233" name="l01233"></a><span class="lineno"> 1233</span><span class="comment">   * in a synchronized way.</span></div>
<div class="line"><a id="l01234" name="l01234"></a><span class="lineno"> 1234</span><span class="comment">   *</span></div>
<div class="line"><a id="l01235" name="l01235"></a><span class="lineno"> 1235</span><span class="comment">   * @see Server_socket::m_connecting_socks and Server_socket::m_unaccepted_socks for the closely</span></div>
<div class="line"><a id="l01236" name="l01236"></a><span class="lineno"> 1236</span><span class="comment">   *      related inverse.</span></div>
<div class="line"><a id="l01237" name="l01237"></a><span class="lineno"> 1237</span><span class="comment">   */</span></div>
<div class="line"><a id="l01238" name="l01238"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a5629d810d2c7252eaa2243e076dde83f"> 1238</a></span>  <a class="code hl_typedef" href="classflow_1_1util_1_1Shared__ptr__alias__holder.html#aa4f1af88393042e60159a3a67f0accbc">Server_socket::Ptr</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a5629d810d2c7252eaa2243e076dde83f">m_originating_serv</a>;</div>
<div class="line"><a id="l01239" name="l01239"></a><span class="lineno"> 1239</span><span class="comment"></span> </div>
<div class="line"><a id="l01240" name="l01240"></a><span class="lineno"> 1240</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01241" name="l01241"></a><span class="lineno"> 1241</span><span class="comment">   * The Receive buffer; Node feeds data at the back; user consumes data at the front.  Contains</span></div>
<div class="line"><a id="l01242" name="l01242"></a><span class="lineno"> 1242</span><span class="comment">   * application-layer data received from the other side, to be read by user via receive() and</span></div>
<div class="line"><a id="l01243" name="l01243"></a><span class="lineno"> 1243</span><span class="comment">   * similar.</span></div>
<div class="line"><a id="l01244" name="l01244"></a><span class="lineno"> 1244</span><span class="comment">   *</span></div>
<div class="line"><a id="l01245" name="l01245"></a><span class="lineno"> 1245</span><span class="comment">   * A maximum cumulative byte count is maintained.  If data are received that would exceed this max</span></div>
<div class="line"><a id="l01246" name="l01246"></a><span class="lineno"> 1246</span><span class="comment">   * (i.e., the user is not retrieving the data fast enough to keep up), these data are dropped (and</span></div>
<div class="line"><a id="l01247" name="l01247"></a><span class="lineno"> 1247</span><span class="comment">   * if we use ACKs would be eventually treated as dropped by the other side).</span></div>
<div class="line"><a id="l01248" name="l01248"></a><span class="lineno"> 1248</span><span class="comment">   *</span></div>
<div class="line"><a id="l01249" name="l01249"></a><span class="lineno"> 1249</span><span class="comment">   * Note that this is a high-level structure, near the application layer.  This does not store any</span></div>
<div class="line"><a id="l01250" name="l01250"></a><span class="lineno"> 1250</span><span class="comment">   * metadata, like sequence numbers, or data not ready to be consumed by the user (such as</span></div>
<div class="line"><a id="l01251" name="l01251"></a><span class="lineno"> 1251</span><span class="comment">   * out-of-order packets, if we implement that).  Such packets and data should be stored elsewhere.</span></div>
<div class="line"><a id="l01252" name="l01252"></a><span class="lineno"> 1252</span><span class="comment">   *</span></div>
<div class="line"><a id="l01253" name="l01253"></a><span class="lineno"> 1253</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l01254" name="l01254"></a><span class="lineno"> 1254</span><span class="comment">   * This can be write-accessed simultaneously by thread W (when receiving by Node)</span></div>
<div class="line"><a id="l01255" name="l01255"></a><span class="lineno"> 1255</span><span class="comment">   * and a user thread U != W (in receive(), etc.).  It is thus protected by a mutex.</span></div>
<div class="line"><a id="l01256" name="l01256"></a><span class="lineno"> 1256</span><span class="comment">   */</span></div>
<div class="line"><a id="l01257" name="l01257"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#aae9cb8f2dbd50ddaa0265d940b149ef3"> 1257</a></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Socket__buffer.html">Socket_buffer</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#aae9cb8f2dbd50ddaa0265d940b149ef3">m_rcv_buf</a>;</div>
<div class="line"><a id="l01258" name="l01258"></a><span class="lineno"> 1258</span><span class="comment"></span> </div>
<div class="line"><a id="l01259" name="l01259"></a><span class="lineno"> 1259</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01260" name="l01260"></a><span class="lineno"> 1260</span><span class="comment">   * The Send buffer; user feeds data at the back; Node consumes data at the front.  Contains</span></div>
<div class="line"><a id="l01261" name="l01261"></a><span class="lineno"> 1261</span><span class="comment">   * application-layer data to be sent to the other side as supplied by user via send() and friends.</span></div>
<div class="line"><a id="l01262" name="l01262"></a><span class="lineno"> 1262</span><span class="comment">   *</span></div>
<div class="line"><a id="l01263" name="l01263"></a><span class="lineno"> 1263</span><span class="comment">   * A maximum cumulative byte count is maintained.  If data are supplied that would exceed</span></div>
<div class="line"><a id="l01264" name="l01264"></a><span class="lineno"> 1264</span><span class="comment">   * this max (i.e., the Node is not sending the data fast enough to keep up), send() will</span></div>
<div class="line"><a id="l01265" name="l01265"></a><span class="lineno"> 1265</span><span class="comment">   * inform the caller that fewer bytes than intended have been buffered.  Typically this happens if</span></div>
<div class="line"><a id="l01266" name="l01266"></a><span class="lineno"> 1266</span><span class="comment">   * the congestion control window is full, so data are getting buffered in #m_snd_buf instead of</span></div>
<div class="line"><a id="l01267" name="l01267"></a><span class="lineno"> 1267</span><span class="comment">   * being immediately consumed and sent.</span></div>
<div class="line"><a id="l01268" name="l01268"></a><span class="lineno"> 1268</span><span class="comment">   *</span></div>
<div class="line"><a id="l01269" name="l01269"></a><span class="lineno"> 1269</span><span class="comment">   * Note that this is a high-level structure, near the application layer.  This does not store any</span></div>
<div class="line"><a id="l01270" name="l01270"></a><span class="lineno"> 1270</span><span class="comment">   * metadata, like sequence numbers, or data not ready to be consumed by the user (such as</span></div>
<div class="line"><a id="l01271" name="l01271"></a><span class="lineno"> 1271</span><span class="comment">   * out-of-order packets, if we implement that).  Such packets and data should be stored elsewhere.</span></div>
<div class="line"><a id="l01272" name="l01272"></a><span class="lineno"> 1272</span><span class="comment">   *</span></div>
<div class="line"><a id="l01273" name="l01273"></a><span class="lineno"> 1273</span><span class="comment">   * Thread safety: Analogous to #m_rcv_buf.</span></div>
<div class="line"><a id="l01274" name="l01274"></a><span class="lineno"> 1274</span><span class="comment">   */</span></div>
<div class="line"><a id="l01275" name="l01275"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a993edf95f6bce2e57e7111e42533dc74"> 1275</a></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Socket__buffer.html">Socket_buffer</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a993edf95f6bce2e57e7111e42533dc74">m_snd_buf</a>;</div>
<div class="line"><a id="l01276" name="l01276"></a><span class="lineno"> 1276</span><span class="comment"></span> </div>
<div class="line"><a id="l01277" name="l01277"></a><span class="lineno"> 1277</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01278" name="l01278"></a><span class="lineno"> 1278</span><span class="comment">   * The #Error_code causing disconnection (if one has occurred or is occurring)</span></div>
<div class="line"><a id="l01279" name="l01279"></a><span class="lineno"> 1279</span><span class="comment">   * on this socket; otherwise a clear (success) #Error_code.  This starts as success</span></div>
<div class="line"><a id="l01280" name="l01280"></a><span class="lineno"> 1280</span><span class="comment">   * and may move to one non-success value and then never change after that.  Graceful connection</span></div>
<div class="line"><a id="l01281" name="l01281"></a><span class="lineno"> 1281</span><span class="comment">   * termination is (unlike in BSD sockets, where this is indicated with receive() returning 0, not an</span></div>
<div class="line"><a id="l01282" name="l01282"></a><span class="lineno"> 1282</span><span class="comment">   * error) indeed counted as a non-success value for #m_disconnect_cause.</span></div>
<div class="line"><a id="l01283" name="l01283"></a><span class="lineno"> 1283</span><span class="comment">   *</span></div>
<div class="line"><a id="l01284" name="l01284"></a><span class="lineno"> 1284</span><span class="comment">   * Exception: if, during graceful close, the connection must be closed abruptly (due to error,</span></div>
<div class="line"><a id="l01285" name="l01285"></a><span class="lineno"> 1285</span><span class="comment">   * including error::Code::S_USER_CLOSED_ABRUPTLY), #m_disconnect_cause may change a second time (from &quot;graceful close&quot;</span></div>
<div class="line"><a id="l01286" name="l01286"></a><span class="lineno"> 1286</span><span class="comment">   * to &quot;abrupt closure&quot;).</span></div>
<div class="line"><a id="l01287" name="l01287"></a><span class="lineno"> 1287</span><span class="comment">   *</span></div>
<div class="line"><a id="l01288" name="l01288"></a><span class="lineno"> 1288</span><span class="comment">   * As in TCP net-stacks, one cannot recover from a transmission error or termination on the socket</span></div>
<div class="line"><a id="l01289" name="l01289"></a><span class="lineno"> 1289</span><span class="comment">   * (fake &quot;error&quot; `EWOULDBLOCK`/`EAGAIN` excepted), which is why this can only go success -&gt;</span></div>
<div class="line"><a id="l01290" name="l01290"></a><span class="lineno"> 1290</span><span class="comment">   * non-success and never change after that.</span></div>
<div class="line"><a id="l01291" name="l01291"></a><span class="lineno"> 1291</span><span class="comment">   *</span></div>
<div class="line"><a id="l01292" name="l01292"></a><span class="lineno"> 1292</span><span class="comment">   * How to report this to the user: attempting to `*receive()` when not Readable while</span></div>
<div class="line"><a id="l01293" name="l01293"></a><span class="lineno"> 1293</span><span class="comment">   * #m_disconnect_cause is not success =&gt; `*receive()` returns this #Error_code to the user; and</span></div>
<div class="line"><a id="l01294" name="l01294"></a><span class="lineno"> 1294</span><span class="comment">   * similarly for `*send()` and Writable.</span></div>
<div class="line"><a id="l01295" name="l01295"></a><span class="lineno"> 1295</span><span class="comment">   *</span></div>
<div class="line"><a id="l01296" name="l01296"></a><span class="lineno"> 1296</span><span class="comment">   * I emphasize that this should happen only after Receive buffer has been emptied; otherwise user</span></div>
<div class="line"><a id="l01297" name="l01297"></a><span class="lineno"> 1297</span><span class="comment">   * will not be able to read queued up received data after the Node internally detects connection</span></div>
<div class="line"><a id="l01298" name="l01298"></a><span class="lineno"> 1298</span><span class="comment">   * termination.  By the same token, if the Node can still reasonably send data to the other side,</span></div>
<div class="line"><a id="l01299" name="l01299"></a><span class="lineno"> 1299</span><span class="comment">   * and Send buffer is not empty, and #m_disconnect_cause is not success, the Node should only halt</span></div>
<div class="line"><a id="l01300" name="l01300"></a><span class="lineno"> 1300</span><span class="comment">   * the packet sending once Send buffer has been emptied.</span></div>
<div class="line"><a id="l01301" name="l01301"></a><span class="lineno"> 1301</span><span class="comment">   *</span></div>
<div class="line"><a id="l01302" name="l01302"></a><span class="lineno"> 1302</span><span class="comment">   * This should be success in all states except State::S_CLOSED and</span></div>
<div class="line"><a id="l01303" name="l01303"></a><span class="lineno"> 1303</span><span class="comment">   * State::S_OPEN + Open_sub_state::S_DISCONNECTING.</span></div>
<div class="line"><a id="l01304" name="l01304"></a><span class="lineno"> 1304</span><span class="comment">   *</span></div>
<div class="line"><a id="l01305" name="l01305"></a><span class="lineno"> 1305</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l01306" name="l01306"></a><span class="lineno"> 1306</span><span class="comment">   * Since user threads will access this at least via receive() and send(), while</span></div>
<div class="line"><a id="l01307" name="l01307"></a><span class="lineno"> 1307</span><span class="comment">   * thread W may set it having detected disconnection, this must be protected by a mutex.</span></div>
<div class="line"><a id="l01308" name="l01308"></a><span class="lineno"> 1308</span><span class="comment">   */</span></div>
<div class="line"><a id="l01309" name="l01309"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a4fb8e8df98efa023e8bd4bd825475a18"> 1309</a></span>  <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a4fb8e8df98efa023e8bd4bd825475a18">m_disconnect_cause</a>;</div>
<div class="line"><a id="l01310" name="l01310"></a><span class="lineno"> 1310</span><span class="comment"></span> </div>
<div class="line"><a id="l01311" name="l01311"></a><span class="lineno"> 1311</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01312" name="l01312"></a><span class="lineno"> 1312</span><span class="comment">   * If `!m_active_connect`, this contains the serialized metadata that the user supplied on</span></div>
<div class="line"><a id="l01313" name="l01313"></a><span class="lineno"> 1313</span><span class="comment">   * the other side when initiating the connect; otherwise this is the serialized metadata that the user</span></div>
<div class="line"><a id="l01314" name="l01314"></a><span class="lineno"> 1314</span><span class="comment">   * supplied on this side when initiating the connect.  In either case (though obviously more</span></div>
<div class="line"><a id="l01315" name="l01315"></a><span class="lineno"> 1315</span><span class="comment">   * useful in the `!m_active_connect` case) it can be obtained via get_connect_metadata().</span></div>
<div class="line"><a id="l01316" name="l01316"></a><span class="lineno"> 1316</span><span class="comment">   * In the `m_active_connect` case, this is also needed if we must re-send the original SYN</span></div>
<div class="line"><a id="l01317" name="l01317"></a><span class="lineno"> 1317</span><span class="comment">   * (retransmission).</span></div>
<div class="line"><a id="l01318" name="l01318"></a><span class="lineno"> 1318</span><span class="comment">   *</span></div>
<div class="line"><a id="l01319" name="l01319"></a><span class="lineno"> 1319</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l01320" name="l01320"></a><span class="lineno"> 1320</span><span class="comment">   * Same as #m_snd_buf and #m_rcv_buf (protected by #m_mutex).  This would not be</span></div>
<div class="line"><a id="l01321" name="l01321"></a><span class="lineno"> 1321</span><span class="comment">   * necessary, since this value is immutable once user gets access to `*this`, and threads other than</span></div>
<div class="line"><a id="l01322" name="l01322"></a><span class="lineno"> 1322</span><span class="comment">   * W can access it, but sock_free_memory() does clear it while the user may be accessing it.  Due</span></div>
<div class="line"><a id="l01323" name="l01323"></a><span class="lineno"> 1323</span><span class="comment">   * to that caveat, we have to lock it.</span></div>
<div class="line"><a id="l01324" name="l01324"></a><span class="lineno"> 1324</span><span class="comment">   */</span></div>
<div class="line"><a id="l01325" name="l01325"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a322dddf34a06bb199dab02c993bad686"> 1325</a></span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#af09888b3a8feaff209b6625e493bc338">util::Blob</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a322dddf34a06bb199dab02c993bad686">m_serialized_metadata</a>;</div>
<div class="line"><a id="l01326" name="l01326"></a><span class="lineno"> 1326</span><span class="comment"></span> </div>
<div class="line"><a id="l01327" name="l01327"></a><span class="lineno"> 1327</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01328" name="l01328"></a><span class="lineno"> 1328</span><span class="comment">   * This object&#39;s mutex.  The protected items are #m_state, #m_open_sub_state, #m_disconnect_cause,</span></div>
<div class="line"><a id="l01329" name="l01329"></a><span class="lineno"> 1329</span><span class="comment">   * #m_node, #m_rcv_buf, #m_snd_buf, #m_serialized_metadata.</span></div>
<div class="line"><a id="l01330" name="l01330"></a><span class="lineno"> 1330</span><span class="comment">   *</span></div>
<div class="line"><a id="l01331" name="l01331"></a><span class="lineno"> 1331</span><span class="comment">   * Generally speaking, if 2 or more of the protected variables must be changed in the same</span></div>
<div class="line"><a id="l01332" name="l01332"></a><span class="lineno"> 1332</span><span class="comment">   * non-blocking &quot;operation&quot; (for some reasonable definition of &quot;operation&quot;), they should probably</span></div>
<div class="line"><a id="l01333" name="l01333"></a><span class="lineno"> 1333</span><span class="comment">   * be changed within the same #m_mutex-locking critical section.  For example, if closing the</span></div>
<div class="line"><a id="l01334" name="l01334"></a><span class="lineno"> 1334</span><span class="comment">   * socket in thread W due to an incoming RST, one should lock #m_mutex, clear both buffers, set</span></div>
<div class="line"><a id="l01335" name="l01335"></a><span class="lineno"> 1335</span><span class="comment">   * #m_disconnect_cause, change `m_state = State::S_CLOSED`, and then unlock #m_mutex.  Then thread U != W</span></div>
<div class="line"><a id="l01336" name="l01336"></a><span class="lineno"> 1336</span><span class="comment">   * will observe all this state changed at the &quot;same time,&quot; which is desirable.</span></div>
<div class="line"><a id="l01337" name="l01337"></a><span class="lineno"> 1337</span><span class="comment">   */</span></div>
<div class="line"><a id="l01338" name="l01338"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ab41b19ed4e62cb14fcd7dac81e4a8f41"> 1338</a></span>  <span class="keyword">mutable</span> <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#ad1e36619c78b15f46576a18678a4ee67">Mutex</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ab41b19ed4e62cb14fcd7dac81e4a8f41">m_mutex</a>;</div>
<div class="line"><a id="l01339" name="l01339"></a><span class="lineno"> 1339</span><span class="comment"></span> </div>
<div class="line"><a id="l01340" name="l01340"></a><span class="lineno"> 1340</span><span class="comment">  /// See remote_endpoint().  Should be set before user gets access to `*this` and not changed afterwards.</span></div>
<div class="line"><a id="l01341" name="l01341"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a218ec098984b754b43940001f59ab787"> 1341</a></span><span class="comment"></span>  <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a218ec098984b754b43940001f59ab787">m_remote_endpoint</a>;</div>
<div class="line"><a id="l01342" name="l01342"></a><span class="lineno"> 1342</span><span class="comment"></span> </div>
<div class="line"><a id="l01343" name="l01343"></a><span class="lineno"> 1343</span><span class="comment">  /// See local_port().  Should be set before user gets access to `*this` and not changed afterwards.</span></div>
<div class="line"><a id="l01344" name="l01344"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a7b65c1b26e38a2ae614d9a12edfa57dd"> 1344</a></span><span class="comment"></span>  <a class="code hl_typedef" href="namespaceflow_1_1net__flow.html#a079d8cd87a68d1c5f04c6bce71f0061d">flow_port_t</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a7b65c1b26e38a2ae614d9a12edfa57dd">m_local_port</a>;</div>
<div class="line"><a id="l01345" name="l01345"></a><span class="lineno"> 1345</span><span class="comment"></span> </div>
<div class="line"><a id="l01346" name="l01346"></a><span class="lineno"> 1346</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01347" name="l01347"></a><span class="lineno"> 1347</span><span class="comment">   * Current internal state of the socket.  Note this is a very central piece of information and is analogous</span></div>
<div class="line"><a id="l01348" name="l01348"></a><span class="lineno"> 1348</span><span class="comment">   * to TCP&#39;s &quot;state&quot; (ESTABLISHED, etc. etc.).</span></div>
<div class="line"><a id="l01349" name="l01349"></a><span class="lineno"> 1349</span><span class="comment">   *</span></div>
<div class="line"><a id="l01350" name="l01350"></a><span class="lineno"> 1350</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be</span></div>
<div class="line"><a id="l01351" name="l01351"></a><span class="lineno"> 1351</span><span class="comment">   * accessed outside of thread W and is not protected by a mutex.</span></div>
<div class="line"><a id="l01352" name="l01352"></a><span class="lineno"> 1352</span><span class="comment">   */</span></div>
<div class="line"><a id="l01353" name="l01353"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a2c5de5df50268168cbbad82eaf90fa93"> 1353</a></span>  <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Peer__socket.html#a9537860c2c2a7380a45a525e5121880f">Int_state</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a2c5de5df50268168cbbad82eaf90fa93">m_int_state</a>;</div>
<div class="line"><a id="l01354" name="l01354"></a><span class="lineno"> 1354</span><span class="comment"></span> </div>
<div class="line"><a id="l01355" name="l01355"></a><span class="lineno"> 1355</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01356" name="l01356"></a><span class="lineno"> 1356</span><span class="comment">   * The queue of DATA packets received while in Int_state::S_SYN_RCVD state before the</span></div>
<div class="line"><a id="l01357" name="l01357"></a><span class="lineno"> 1357</span><span class="comment">   * Syn_ack_ack_packet arrives to move us to Int_state::S_ESTABLISHED</span></div>
<div class="line"><a id="l01358" name="l01358"></a><span class="lineno"> 1358</span><span class="comment">   * state, at which point these packets can be processed normally.  Such</span></div>
<div class="line"><a id="l01359" name="l01359"></a><span class="lineno"> 1359</span><span class="comment">   * DATA packets would not normally exist, but they can exist if the SYN_ACK_ACK is lost or DATA</span></div>
<div class="line"><a id="l01360" name="l01360"></a><span class="lineno"> 1360</span><span class="comment">   * packets are re-ordered to go ahead of it.  See Node::handle_data_to_syn_rcvd() for more</span></div>
<div class="line"><a id="l01361" name="l01361"></a><span class="lineno"> 1361</span><span class="comment">   * detail.</span></div>
<div class="line"><a id="l01362" name="l01362"></a><span class="lineno"> 1362</span><span class="comment">   *</span></div>
<div class="line"><a id="l01363" name="l01363"></a><span class="lineno"> 1363</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W</span></div>
<div class="line"><a id="l01364" name="l01364"></a><span class="lineno"> 1364</span><span class="comment">   * and is not protected by a mutex.</span></div>
<div class="line"><a id="l01365" name="l01365"></a><span class="lineno"> 1365</span><span class="comment">   */</span></div>
<div class="line"><a id="l01366" name="l01366"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a48320d96118a37626f1852626965e6ed"> 1366</a></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a1869760d5cfc5c0d22665e5db88710e4">Rcv_syn_rcvd_data_q</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a48320d96118a37626f1852626965e6ed">m_rcv_syn_rcvd_data_q</a>;</div>
<div class="line"><a id="l01367" name="l01367"></a><span class="lineno"> 1367</span><span class="comment"></span> </div>
<div class="line"><a id="l01368" name="l01368"></a><span class="lineno"> 1368</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01369" name="l01369"></a><span class="lineno"> 1369</span><span class="comment">   * The running total count of bytes in the `m_data` fields of #m_rcv_syn_rcvd_data_q.  Undefined</span></div>
<div class="line"><a id="l01370" name="l01370"></a><span class="lineno"> 1370</span><span class="comment">   * when the latter is empty.  Used to limit its size.  This gains meaning only in thread W.  This</span></div>
<div class="line"><a id="l01371" name="l01371"></a><span class="lineno"> 1371</span><span class="comment">   * should NOT be accessed outside of thread W and is not protected by a mutex.</span></div>
<div class="line"><a id="l01372" name="l01372"></a><span class="lineno"> 1372</span><span class="comment">   */</span></div>
<div class="line"><a id="l01373" name="l01373"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a1553bbefc3407cf84eaa8e256c6cffff"> 1373</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a1553bbefc3407cf84eaa8e256c6cffff">m_rcv_syn_rcvd_data_cumulative_size</a>;</div>
<div class="line"><a id="l01374" name="l01374"></a><span class="lineno"> 1374</span><span class="comment"></span> </div>
<div class="line"><a id="l01375" name="l01375"></a><span class="lineno"> 1375</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01376" name="l01376"></a><span class="lineno"> 1376</span><span class="comment">   * The Initial Sequence Number (ISN) contained in the original Syn_packet or</span></div>
<div class="line"><a id="l01377" name="l01377"></a><span class="lineno"> 1377</span><span class="comment">   * Syn_ack_packet we received.</span></div>
<div class="line"><a id="l01378" name="l01378"></a><span class="lineno"> 1378</span><span class="comment">   *</span></div>
<div class="line"><a id="l01379" name="l01379"></a><span class="lineno"> 1379</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01380" name="l01380"></a><span class="lineno"> 1380</span><span class="comment">   * not protected by a mutex.  Useful at least in verifying the validity of duplicate SYNs and</span></div>
<div class="line"><a id="l01381" name="l01381"></a><span class="lineno"> 1381</span><span class="comment">   * SYN_ACKs.</span></div>
<div class="line"><a id="l01382" name="l01382"></a><span class="lineno"> 1382</span><span class="comment">   */</span></div>
<div class="line"><a id="l01383" name="l01383"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a5dc05d1f5deb71e1259c5d5aad1fcf84"> 1383</a></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Sequence__number.html">Sequence_number</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a5dc05d1f5deb71e1259c5d5aad1fcf84">m_rcv_init_seq_num</a>;</div>
<div class="line"><a id="l01384" name="l01384"></a><span class="lineno"> 1384</span><span class="comment"></span> </div>
<div class="line"><a id="l01385" name="l01385"></a><span class="lineno"> 1385</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01386" name="l01386"></a><span class="lineno"> 1386</span><span class="comment">   * The maximal sequence number R from the remote side such that all data with sequence numbers</span></div>
<div class="line"><a id="l01387" name="l01387"></a><span class="lineno"> 1387</span><span class="comment">   * strictly less than R in this connection have been received by us and placed into the Receive</span></div>
<div class="line"><a id="l01388" name="l01388"></a><span class="lineno"> 1388</span><span class="comment">   * buffer.  This first gains meaning upon receiving SYN and is the sequence number of that SYN,</span></div>
<div class="line"><a id="l01389" name="l01389"></a><span class="lineno"> 1389</span><span class="comment">   * plus one (as in TCP); or upon receiving SYN_ACK (similarly).  Note that received packets past</span></div>
<div class="line"><a id="l01390" name="l01390"></a><span class="lineno"> 1390</span><span class="comment">   * this sequence number may exist, but if so there is at least one missing packet (the one at</span></div>
<div class="line"><a id="l01391" name="l01391"></a><span class="lineno"> 1391</span><span class="comment">   * #m_rcv_next_seq_num) preceding all of them.</span></div>
<div class="line"><a id="l01392" name="l01392"></a><span class="lineno"> 1392</span><span class="comment">   *</span></div>
<div class="line"><a id="l01393" name="l01393"></a><span class="lineno"> 1393</span><span class="comment">   * @see #m_rcv_packets_with_gaps.</span></div>
<div class="line"><a id="l01394" name="l01394"></a><span class="lineno"> 1394</span><span class="comment">   *</span></div>
<div class="line"><a id="l01395" name="l01395"></a><span class="lineno"> 1395</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01396" name="l01396"></a><span class="lineno"> 1396</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01397" name="l01397"></a><span class="lineno"> 1397</span><span class="comment">   */</span></div>
<div class="line"><a id="l01398" name="l01398"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a13c640ebd14a75df3894e7d885d16f5f"> 1398</a></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Sequence__number.html">Sequence_number</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a13c640ebd14a75df3894e7d885d16f5f">m_rcv_next_seq_num</a>;</div>
<div class="line"><a id="l01399" name="l01399"></a><span class="lineno"> 1399</span><span class="comment"></span> </div>
<div class="line"><a id="l01400" name="l01400"></a><span class="lineno"> 1400</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01401" name="l01401"></a><span class="lineno"> 1401</span><span class="comment">   * The sequence-number-ordered collection of all</span></div>
<div class="line"><a id="l01402" name="l01402"></a><span class="lineno"> 1402</span><span class="comment">   * received-and-not-dropped-due-to-buffer-overflow packets such that at least</span></div>
<div class="line"><a id="l01403" name="l01403"></a><span class="lineno"> 1403</span><span class="comment">   * one unreceived-or-otherwise-unknown datum precedes all sequence numbers in this collection;</span></div>
<div class="line"><a id="l01404" name="l01404"></a><span class="lineno"> 1404</span><span class="comment">   * a/k/a the reassembly queue if retransmission is enabled.</span></div>
<div class="line"><a id="l01405" name="l01405"></a><span class="lineno"> 1405</span><span class="comment">   * With retransmission off, the only purpose of keeping this structure at all is to detect any</span></div>
<div class="line"><a id="l01406" name="l01406"></a><span class="lineno"> 1406</span><span class="comment">   * already-received-and-given-to-Receive-buffer packet coming in again; such a packet should be</span></div>
<div class="line"><a id="l01407" name="l01407"></a><span class="lineno"> 1407</span><span class="comment">   * ACKed but NOT given to the Receive buffer again (avoid data duplication).  With retransmission</span></div>
<div class="line"><a id="l01408" name="l01408"></a><span class="lineno"> 1408</span><span class="comment">   * on, this is additionally used as the reassembly queue (storing the non-contiguous data until</span></div>
<div class="line"><a id="l01409" name="l01409"></a><span class="lineno"> 1409</span><span class="comment">   * the gaps are filled in).</span></div>
<div class="line"><a id="l01410" name="l01410"></a><span class="lineno"> 1410</span><span class="comment">   *</span></div>
<div class="line"><a id="l01411" name="l01411"></a><span class="lineno"> 1411</span><span class="comment">   * The structure is best explained by breaking down the sequence number space.  I list the</span></div>
<div class="line"><a id="l01412" name="l01412"></a><span class="lineno"> 1412</span><span class="comment">   * sequence number ranges in increasing order starting with the ISN.  Let `last_rcv_seq_num` be the</span></div>
<div class="line"><a id="l01413" name="l01413"></a><span class="lineno"> 1413</span><span class="comment">   * sequence number of the last datum to have been received (and not dropped due to insufficient</span></div>
<div class="line"><a id="l01414" name="l01414"></a><span class="lineno"> 1414</span><span class="comment">   * Receive buffer space), for exposition purposes.</span></div>
<div class="line"><a id="l01415" name="l01415"></a><span class="lineno"> 1415</span><span class="comment">   *</span></div>
<div class="line"><a id="l01416" name="l01416"></a><span class="lineno"> 1416</span><span class="comment">   *   - #m_rcv_init_seq_num =</span></div>
<div class="line"><a id="l01417" name="l01417"></a><span class="lineno"> 1417</span><span class="comment">   *     - SYN or SYN_ACK</span></div>
<div class="line"><a id="l01418" name="l01418"></a><span class="lineno"> 1418</span><span class="comment">   *</span></div>
<div class="line"><a id="l01419" name="l01419"></a><span class="lineno"> 1419</span><span class="comment">   *   - [`m_rcv_init_seq_num + 1`, `m_rcv_next_seq_num - 1`] =</span></div>
<div class="line"><a id="l01420" name="l01420"></a><span class="lineno"> 1420</span><span class="comment">   *     - Largest possible range of sequence numbers such that each datum represented by this range</span></div>
<div class="line"><a id="l01421" name="l01421"></a><span class="lineno"> 1421</span><span class="comment">   *       has been received (and not dropped due to insufficient Receive buffer space) and copied to</span></div>
<div class="line"><a id="l01422" name="l01422"></a><span class="lineno"> 1422</span><span class="comment">   *       the Receive buffer for user retrieval.</span></div>
<div class="line"><a id="l01423" name="l01423"></a><span class="lineno"> 1423</span><span class="comment">   *</span></div>
<div class="line"><a id="l01424" name="l01424"></a><span class="lineno"> 1424</span><span class="comment">   *   - [#m_rcv_next_seq_num, `m_rcv_next_seq_num + N - 1`] =</span></div>
<div class="line"><a id="l01425" name="l01425"></a><span class="lineno"> 1425</span><span class="comment">   *     - The first packet after the ISN that has not yet been received (or has been received but has</span></div>
<div class="line"><a id="l01426" name="l01426"></a><span class="lineno"> 1426</span><span class="comment">   *       been dropped due to insufficient Receive buffer space).  `N` is the (unknown to us) length of</span></div>
<div class="line"><a id="l01427" name="l01427"></a><span class="lineno"> 1427</span><span class="comment">   *       that packet.  `N` &gt; 0.  This can be seen as the first &quot;gap&quot; in the received sequence number</span></div>
<div class="line"><a id="l01428" name="l01428"></a><span class="lineno"> 1428</span><span class="comment">   *       space.</span></div>
<div class="line"><a id="l01429" name="l01429"></a><span class="lineno"> 1429</span><span class="comment">   *</span></div>
<div class="line"><a id="l01430" name="l01430"></a><span class="lineno"> 1430</span><span class="comment">   *   - [`m_rcv_next_seq_num + N`, `last_rcv_seq_num`] =</span></div>
<div class="line"><a id="l01431" name="l01431"></a><span class="lineno"> 1431</span><span class="comment">   *     - The remaining packets up to and including the last byte that has been received (and not</span></div>
<div class="line"><a id="l01432" name="l01432"></a><span class="lineno"> 1432</span><span class="comment">   *       dropped due to insufficient Receive buffer space).  Each packet in this range is one of the</span></div>
<div class="line"><a id="l01433" name="l01433"></a><span class="lineno"> 1433</span><span class="comment">   *       following:</span></div>
<div class="line"><a id="l01434" name="l01434"></a><span class="lineno"> 1434</span><span class="comment">   *       - received (and not dropped due to insufficient Receive buffer space);</span></div>
<div class="line"><a id="l01435" name="l01435"></a><span class="lineno"> 1435</span><span class="comment">   *       - not received (or received and dropped due to insufficient Receive buffer space).</span></div>
<div class="line"><a id="l01436" name="l01436"></a><span class="lineno"> 1436</span><span class="comment">   *</span></div>
<div class="line"><a id="l01437" name="l01437"></a><span class="lineno"> 1437</span><span class="comment">   *   - [`last_rcv_seq_num + 1`, ...] =</span></div>
<div class="line"><a id="l01438" name="l01438"></a><span class="lineno"> 1438</span><span class="comment">   *     - All remaining not-yet-received (or received but dropped due to insufficient Receive buffer</span></div>
<div class="line"><a id="l01439" name="l01439"></a><span class="lineno"> 1439</span><span class="comment">   *       space) packets.</span></div>
<div class="line"><a id="l01440" name="l01440"></a><span class="lineno"> 1440</span><span class="comment">   *</span></div>
<div class="line"><a id="l01441" name="l01441"></a><span class="lineno"> 1441</span><span class="comment">   * #m_rcv_packets_with_gaps contains all Received_packets in the range [`m_rcv_next_seq_num + N`,</span></div>
<div class="line"><a id="l01442" name="l01442"></a><span class="lineno"> 1442</span><span class="comment">   * `last_rcv_seq_num`], with each particular Received_packet&#39;s first sequence number as its key.  If</span></div>
<div class="line"><a id="l01443" name="l01443"></a><span class="lineno"> 1443</span><span class="comment">   * there are no gaps -- all received sequence numbers are followed by unreceived sequence numbers</span></div>
<div class="line"><a id="l01444" name="l01444"></a><span class="lineno"> 1444</span><span class="comment">   * -- then that range is empty and so is #m_rcv_packets_with_gaps.  All the other ranges can be</span></div>
<div class="line"><a id="l01445" name="l01445"></a><span class="lineno"> 1445</span><span class="comment">   * null (empty) as well.  If there are no received-and-undropped packets, then `m_rcv_init_seq_num</span></div>
<div class="line"><a id="l01446" name="l01446"></a><span class="lineno"> 1446</span><span class="comment">   * == m_rcv_next_seq_num`, which is the initial situation.</span></div>
<div class="line"><a id="l01447" name="l01447"></a><span class="lineno"> 1447</span><span class="comment">   *</span></div>
<div class="line"><a id="l01448" name="l01448"></a><span class="lineno"> 1448</span><span class="comment">   * The above is an invariant, to be true at the end of each boost.asio handler in thread W, at</span></div>
<div class="line"><a id="l01449" name="l01449"></a><span class="lineno"> 1449</span><span class="comment">   * least.</span></div>
<div class="line"><a id="l01450" name="l01450"></a><span class="lineno"> 1450</span><span class="comment">   *</span></div>
<div class="line"><a id="l01451" name="l01451"></a><span class="lineno"> 1451</span><span class="comment">   * Each received-and-undropped packet therefore is placed into #m_rcv_packets_with_gaps, anywhere</span></div>
<div class="line"><a id="l01452" name="l01452"></a><span class="lineno"> 1452</span><span class="comment">   * in the middle.  If retransmission is off, the data in the packet is added to Receive buffer.</span></div>
<div class="line"><a id="l01453" name="l01453"></a><span class="lineno"> 1453</span><span class="comment">   * If retransmission is on, the data in the packet is NOT added to Receive buffer but instead</span></div>
<div class="line"><a id="l01454" name="l01454"></a><span class="lineno"> 1454</span><span class="comment">   * saved within the structure for later reassembly (see next paragraph).</span></div>
<div class="line"><a id="l01455" name="l01455"></a><span class="lineno"> 1455</span><span class="comment">   *</span></div>
<div class="line"><a id="l01456" name="l01456"></a><span class="lineno"> 1456</span><span class="comment">   * If the [#m_rcv_next_seq_num, ...] (first gap) packet is received-and-not-dropped, then</span></div>
<div class="line"><a id="l01457" name="l01457"></a><span class="lineno"> 1457</span><span class="comment">   * #m_rcv_next_seq_num is incremented by N (the length of that packet), filling the gap.  Moreover,</span></div>
<div class="line"><a id="l01458" name="l01458"></a><span class="lineno"> 1458</span><span class="comment">   * any contiguous packets at the front of #m_rcv_packets_with_gaps, assuming the first packet&#39;s</span></div>
<div class="line"><a id="l01459" name="l01459"></a><span class="lineno"> 1459</span><span class="comment">   * sequence number equals #m_rcv_next_seq_num, must be removed from #m_rcv_packets_with_gaps, and</span></div>
<div class="line"><a id="l01460" name="l01460"></a><span class="lineno"> 1460</span><span class="comment">   * #m_rcv_next_seq_num should be incremented accordingly.  All of this maintains the invariant.  If</span></div>
<div class="line"><a id="l01461" name="l01461"></a><span class="lineno"> 1461</span><span class="comment">   * retransmission is on, the data in the byte sequence formed by this operation is to be placed</span></div>
<div class="line"><a id="l01462" name="l01462"></a><span class="lineno"> 1462</span><span class="comment">   * (in sequence number order) into the Receive buffer (a/k/a reassembly).</span></div>
<div class="line"><a id="l01463" name="l01463"></a><span class="lineno"> 1463</span><span class="comment">   *</span></div>
<div class="line"><a id="l01464" name="l01464"></a><span class="lineno"> 1464</span><span class="comment">   * Conceptually, this is the action of receiving a gap packet which links up following</span></div>
<div class="line"><a id="l01465" name="l01465"></a><span class="lineno"> 1465</span><span class="comment">   * already-received packets to previous already-received packets, which means all of these can go</span></div>
<div class="line"><a id="l01466" name="l01466"></a><span class="lineno"> 1466</span><span class="comment">   * away, as the window slides forward beyond them.</span></div>
<div class="line"><a id="l01467" name="l01467"></a><span class="lineno"> 1467</span><span class="comment">   *</span></div>
<div class="line"><a id="l01468" name="l01468"></a><span class="lineno"> 1468</span><span class="comment">   * If a packet arrives and is already in #m_rcv_packets_with_gaps, then it is a duplicate and is</span></div>
<div class="line"><a id="l01469" name="l01469"></a><span class="lineno"> 1469</span><span class="comment">   * NOT placed on the Receive buffer.  The same holds for any packet with sequence numbers</span></div>
<div class="line"><a id="l01470" name="l01470"></a><span class="lineno"> 1470</span><span class="comment">   * preceding #m_rcv_next_seq_num.</span></div>
<div class="line"><a id="l01471" name="l01471"></a><span class="lineno"> 1471</span><span class="comment">   *</span></div>
<div class="line"><a id="l01472" name="l01472"></a><span class="lineno"> 1472</span><span class="comment">   * The type used is a map sorted by starting sequence number of each packet.  Why?  We need pretty</span></div>
<div class="line"><a id="l01473" name="l01473"></a><span class="lineno"> 1473</span><span class="comment">   * fast middle operations, inserting and checking for existence of arriving packet.  We need fast</span></div>
<div class="line"><a id="l01474" name="l01474"></a><span class="lineno"> 1474</span><span class="comment">   * access to the earliest (smallest sequence number) packet, for when the first gap is filled.</span></div>
<div class="line"><a id="l01475" name="l01475"></a><span class="lineno"> 1475</span><span class="comment">   * `std::map` satisfies these needs: `insert()` and `lower_bound()` are &lt;em&gt;O(log n)&lt;/em&gt;; `begin()` gives the</span></div>
<div class="line"><a id="l01476" name="l01476"></a><span class="lineno"> 1476</span><span class="comment">   * smallest element and is @em O(1).  Iteration is @em O(1) as well.  (All amortized.)</span></div>
<div class="line"><a id="l01477" name="l01477"></a><span class="lineno"> 1477</span><span class="comment">   *</span></div>
<div class="line"><a id="l01478" name="l01478"></a><span class="lineno"> 1478</span><span class="comment">   * ### Memory use ###</span></div>
<div class="line"><a id="l01479" name="l01479"></a><span class="lineno"> 1479</span><span class="comment">   * The above scheme allows for unbounded memory use given certain behavior from the</span></div>
<div class="line"><a id="l01480" name="l01480"></a><span class="lineno"> 1480</span><span class="comment">   * other side, when retransmission is off.  Suppose packets 1, 2, 3 are received; then packets 5,</span></div>
<div class="line"><a id="l01481" name="l01481"></a><span class="lineno"> 1481</span><span class="comment">   * 6, ..., 1000 are received.  Retransmission is off, so eventually the sender</span></div>
<div class="line"><a id="l01482" name="l01482"></a><span class="lineno"> 1482</span><span class="comment">   * may give up on packet 4 and consider it Dropped.  So the gap will forever exist; hence</span></div>
<div class="line"><a id="l01483" name="l01483"></a><span class="lineno"> 1483</span><span class="comment">   * #m_rcv_packets_with_gaps will always hold per-packet data for 5, 6, ..., 1000 (and any</span></div>
<div class="line"><a id="l01484" name="l01484"></a><span class="lineno"> 1484</span><span class="comment">   * subsequent packets).  With retransmission, packet 4 would eventually arrive, or the connection</span></div>
<div class="line"><a id="l01485" name="l01485"></a><span class="lineno"> 1485</span><span class="comment">   * would get RSTed, but without retransmission that doesn&#39;t happen.  Thus memory use will just</span></div>
<div class="line"><a id="l01486" name="l01486"></a><span class="lineno"> 1486</span><span class="comment">   * grow and grow.  Solution: come up with some heuristic that would quite conservatively declare</span></div>
<div class="line"><a id="l01487" name="l01487"></a><span class="lineno"> 1487</span><span class="comment">   * that packet 4 has been &quot;received,&quot; even though it hasn&#39;t. This will plug the hole (packet 4)</span></div>
<div class="line"><a id="l01488" name="l01488"></a><span class="lineno"> 1488</span><span class="comment">   * and clear #m_rcv_packets_with_gaps in this example.  Then if packet 4 does somehow come in, it</span></div>
<div class="line"><a id="l01489" name="l01489"></a><span class="lineno"> 1489</span><span class="comment">   * will get ACKed (like any valid received packet) but will NOT be saved into the Receive buffer,</span></div>
<div class="line"><a id="l01490" name="l01490"></a><span class="lineno"> 1490</span><span class="comment">   * since it will be considered &quot;duplicate&quot; due to already being &quot;received.&quot;  Of course, the</span></div>
<div class="line"><a id="l01491" name="l01491"></a><span class="lineno"> 1491</span><span class="comment">   * heuristic must be such that few if any packets considered &quot;received&quot; this way will actually get</span></div>
<div class="line"><a id="l01492" name="l01492"></a><span class="lineno"> 1492</span><span class="comment">   * delivered eventually, otherwise we may lose a lot of data.  Here is one such heuristic, that is</span></div>
<div class="line"><a id="l01493" name="l01493"></a><span class="lineno"> 1493</span><span class="comment">   * both simple and conservative: let N be some constant (e.g., N = 100).  If</span></div>
<div class="line"><a id="l01494" name="l01494"></a><span class="lineno"> 1494</span><span class="comment">   * `m_rcv_packets_with_gaps.size()` exceeds N (i.e., equals (N + 1)), consider all gap packets</span></div>
<div class="line"><a id="l01495" name="l01495"></a><span class="lineno"> 1495</span><span class="comment">   * preceding #m_rcv_packets_with_gaps&#39;s first sequence number as &quot;received.&quot;  This will, through</span></div>
<div class="line"><a id="l01496" name="l01496"></a><span class="lineno"> 1496</span><span class="comment">   * gap filling logic described above, reduce `m_rcv_packets_with_gaps.size()` to N or less.  Thus it</span></div>
<div class="line"><a id="l01497" name="l01497"></a><span class="lineno"> 1497</span><span class="comment">   * puts a simple upper bound on #m_rcv_packets_with_gaps&#39;s memory; if N = 100 the memory used by</span></div>
<div class="line"><a id="l01498" name="l01498"></a><span class="lineno"> 1498</span><span class="comment">   * the structure is not much (since we don&#39;t store the actual packet data there [but this can get</span></div>
<div class="line"><a id="l01499" name="l01499"></a><span class="lineno"> 1499</span><span class="comment">   * non-trivial with 100,000 sockets all filled up]).  Is it conservative?  Yes.  100 packets</span></div>
<div class="line"><a id="l01500" name="l01500"></a><span class="lineno"> 1500</span><span class="comment">   * arriving after a gap are a near-guarantee those gap packets will never arrive (especially</span></div>
<div class="line"><a id="l01501" name="l01501"></a><span class="lineno"> 1501</span><span class="comment">   * without retransmission, which is the predicate for this entire problem).  Besides, the Drop</span></div>
<div class="line"><a id="l01502" name="l01502"></a><span class="lineno"> 1502</span><span class="comment">   * heuristics on the Sender side almost certainly will consider gap packets with 100 or near 100</span></div>
<div class="line"><a id="l01503" name="l01503"></a><span class="lineno"> 1503</span><span class="comment">   * Acknowledged packets after them as Dropped a long time ago; if the receiving side&#39;s heuristics</span></div>
<div class="line"><a id="l01504" name="l01504"></a><span class="lineno"> 1504</span><span class="comment">   * are far more conservative, then that is good enough.</span></div>
<div class="line"><a id="l01505" name="l01505"></a><span class="lineno"> 1505</span><span class="comment">   *</span></div>
<div class="line"><a id="l01506" name="l01506"></a><span class="lineno"> 1506</span><span class="comment">   * If retransmission is on, then (as noted) the sender&#39;s CWND and retransmission logic will ensure</span></div>
<div class="line"><a id="l01507" name="l01507"></a><span class="lineno"> 1507</span><span class="comment">   * that gaps are filled before more future data are sent, so the above situation will not occur.</span></div>
<div class="line"><a id="l01508" name="l01508"></a><span class="lineno"> 1508</span><span class="comment">   * However if the sender is a bad boy and for some reason sends new data and ignores gaps</span></div>
<div class="line"><a id="l01509" name="l01509"></a><span class="lineno"> 1509</span><span class="comment">   * (possibly malicious behavior), then it would still be a problem.  Since in retransmission mode</span></div>
<div class="line"><a id="l01510" name="l01510"></a><span class="lineno"> 1510</span><span class="comment">   * it&#39;s not OK to just ignore lost packets, we have no choice but to drop received packets when</span></div>
<div class="line"><a id="l01511" name="l01511"></a><span class="lineno"> 1511</span><span class="comment">   * the above situation occurs (similarly to when Receive buffer is exceeded).  This is basically a</span></div>
<div class="line"><a id="l01512" name="l01512"></a><span class="lineno"> 1512</span><span class="comment">   * security measure and should not matter assuming well-behaved operation from the other side.</span></div>
<div class="line"><a id="l01513" name="l01513"></a><span class="lineno"> 1513</span><span class="comment">   * Update: With retransmission on, this structure is now subject to overflow protection with a tighter</span></div>
<div class="line"><a id="l01514" name="l01514"></a><span class="lineno"> 1514</span><span class="comment">   * limit than with rexmit-off; namely, the limit controlling #m_rcv_buf overflow actually applies to</span></div>
<div class="line"><a id="l01515" name="l01515"></a><span class="lineno"> 1515</span><span class="comment">   * the sum of data being stored in #m_rcv_buf and this structure, together.  I.e., a packet is dropped</span></div>
<div class="line"><a id="l01516" name="l01516"></a><span class="lineno"> 1516</span><span class="comment">   * if the total data stored in #m_rcv_buf and #m_rcv_packets_with_gaps equal or exceed the configured</span></div>
<div class="line"><a id="l01517" name="l01517"></a><span class="lineno"> 1517</span><span class="comment">   * limit.  Accordingly, rcv-wnd advertised to other side is based on this sum also.</span></div>
<div class="line"><a id="l01518" name="l01518"></a><span class="lineno"> 1518</span><span class="comment">   *</span></div>
<div class="line"><a id="l01519" name="l01519"></a><span class="lineno"> 1519</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01520" name="l01520"></a><span class="lineno"> 1520</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01521" name="l01521"></a><span class="lineno"> 1521</span><span class="comment">   *</span></div>
<div class="line"><a id="l01522" name="l01522"></a><span class="lineno"> 1522</span><span class="comment">   * @see #m_rcv_reassembly_q_data_size.</span></div>
<div class="line"><a id="l01523" name="l01523"></a><span class="lineno"> 1523</span><span class="comment">   *</span></div>
<div class="line"><a id="l01524" name="l01524"></a><span class="lineno"> 1524</span><span class="comment">   * @todo The memory use of this structure could be greatly optimized if, instead of storing each</span></div>
<div class="line"><a id="l01525" name="l01525"></a><span class="lineno"> 1525</span><span class="comment">   * individual received packet&#39;s metadata separately, we always merged contiguous sequence number</span></div>
<div class="line"><a id="l01526" name="l01526"></a><span class="lineno"> 1526</span><span class="comment">   * ranges.  So for example if packet P1, P2, P3 (contiguous) all arrived in sequence, after</span></div>
<div class="line"><a id="l01527" name="l01527"></a><span class="lineno"> 1527</span><span class="comment">   * missing packet P0, then we&#39;d store P1&#39;s first sequence number and the total data size of</span></div>
<div class="line"><a id="l01528" name="l01528"></a><span class="lineno"> 1528</span><span class="comment">   * P1+P2+P3, in a single `struct` instance.  Since a typical pattern might include 1 lost packet</span></div>
<div class="line"><a id="l01529" name="l01529"></a><span class="lineno"> 1529</span><span class="comment">   * followed by 100 received packets, we&#39;d be able to cut down memory use by a factor of about 100</span></div>
<div class="line"><a id="l01530" name="l01530"></a><span class="lineno"> 1530</span><span class="comment">   * in that case (and thus worry much less about the limit).  Of course the code would get more</span></div>
<div class="line"><a id="l01531" name="l01531"></a><span class="lineno"> 1531</span><span class="comment">   * complex and potentially slower (but not necessarily significantly).</span></div>
<div class="line"><a id="l01532" name="l01532"></a><span class="lineno"> 1532</span><span class="comment">   */</span></div>
<div class="line"><a id="l01533" name="l01533"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ae82958ed6d71be46b96eceaca6214143"> 1533</a></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#addfc181f4d43ab816b2ede9216bf9331">Recvd_pkt_map</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ae82958ed6d71be46b96eceaca6214143">m_rcv_packets_with_gaps</a>;</div>
<div class="line"><a id="l01534" name="l01534"></a><span class="lineno"> 1534</span><span class="comment"></span> </div>
<div class="line"><a id="l01535" name="l01535"></a><span class="lineno"> 1535</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01536" name="l01536"></a><span class="lineno"> 1536</span><span class="comment">   * With retransmission enabled, the sum of Received_packet::m_size over all packets stored in the</span></div>
<div class="line"><a id="l01537" name="l01537"></a><span class="lineno"> 1537</span><span class="comment">   * reassembly queue, #m_rcv_packets_with_gaps.  Stored for performance.</span></div>
<div class="line"><a id="l01538" name="l01538"></a><span class="lineno"> 1538</span><span class="comment">   *</span></div>
<div class="line"><a id="l01539" name="l01539"></a><span class="lineno"> 1539</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01540" name="l01540"></a><span class="lineno"> 1540</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01541" name="l01541"></a><span class="lineno"> 1541</span><span class="comment">   */</span></div>
<div class="line"><a id="l01542" name="l01542"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#aa7398394052c8e634365fb979c294644"> 1542</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#aa7398394052c8e634365fb979c294644">m_rcv_reassembly_q_data_size</a>;</div>
<div class="line"><a id="l01543" name="l01543"></a><span class="lineno"> 1543</span><span class="comment"></span> </div>
<div class="line"><a id="l01544" name="l01544"></a><span class="lineno"> 1544</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01545" name="l01545"></a><span class="lineno"> 1545</span><span class="comment">   * The received packets to be acknowledged in the next low-level ACK packet to be sent to the</span></div>
<div class="line"><a id="l01546" name="l01546"></a><span class="lineno"> 1546</span><span class="comment">   * other side, ordered in the chronological order they were received.  They are accumulated in a</span></div>
<div class="line"><a id="l01547" name="l01547"></a><span class="lineno"> 1547</span><span class="comment">   * data structure because we may not send each desired acknowledgment right away, combining</span></div>
<div class="line"><a id="l01548" name="l01548"></a><span class="lineno"> 1548</span><span class="comment">   * several together, thus reducing overhead at the cost of short delays (or even nearly</span></div>
<div class="line"><a id="l01549" name="l01549"></a><span class="lineno"> 1549</span><span class="comment">   * non-existent delays, as in the case of several DATA packets handled in one</span></div>
<div class="line"><a id="l01550" name="l01550"></a><span class="lineno"> 1550</span><span class="comment">   * NodeLLlow_lvl_recv_and_handle() invocation, i.e., having arrived at nearly at the same time).</span></div>
<div class="line"><a id="l01551" name="l01551"></a><span class="lineno"> 1551</span><span class="comment">   *</span></div>
<div class="line"><a id="l01552" name="l01552"></a><span class="lineno"> 1552</span><span class="comment">   * Any two packets represented by these Individual_ack objects may be duplicates of each other (same</span></div>
<div class="line"><a id="l01553" name="l01553"></a><span class="lineno"> 1553</span><span class="comment">   * Sequence_number, possibly different Individual_ack::m_received_when values).  It&#39;s up to the sender (receiver</span></div>
<div class="line"><a id="l01554" name="l01554"></a><span class="lineno"> 1554</span><span class="comment">   * of ACK) to sort it out.  However, again, they MUST be ordered chronologicaly based on the time</span></div>
<div class="line"><a id="l01555" name="l01555"></a><span class="lineno"> 1555</span><span class="comment">   * when they were received; from earliest to latest.</span></div>
<div class="line"><a id="l01556" name="l01556"></a><span class="lineno"> 1556</span><span class="comment">   *</span></div>
<div class="line"><a id="l01557" name="l01557"></a><span class="lineno"> 1557</span><span class="comment">   * Storing shared pointers to avoid copying of structs (however small) during internal</span></div>
<div class="line"><a id="l01558" name="l01558"></a><span class="lineno"> 1558</span><span class="comment">   * reshuffling; shared instead of raw pointers to not worry about delete.</span></div>
<div class="line"><a id="l01559" name="l01559"></a><span class="lineno"> 1559</span><span class="comment">   *</span></div>
<div class="line"><a id="l01560" name="l01560"></a><span class="lineno"> 1560</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01561" name="l01561"></a><span class="lineno"> 1561</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01562" name="l01562"></a><span class="lineno"> 1562</span><span class="comment">   */</span></div>
<div class="line"><a id="l01563" name="l01563"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ad46ed439a3d118eb2b540e9f99a7b0ca"> 1563</a></span>  std::vector&lt;boost::shared_ptr&lt;Individual_ack&gt;&gt; <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ad46ed439a3d118eb2b540e9f99a7b0ca">m_rcv_pending_acks</a>;</div>
<div class="line"><a id="l01564" name="l01564"></a><span class="lineno"> 1564</span><span class="comment"></span> </div>
<div class="line"><a id="l01565" name="l01565"></a><span class="lineno"> 1565</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01566" name="l01566"></a><span class="lineno"> 1566</span><span class="comment">   * Helper state, to be used while inside either Node::low_lvl_recv_and_handle() or</span></div>
<div class="line"><a id="l01567" name="l01567"></a><span class="lineno"> 1567</span><span class="comment">   * async part of Node::async_wait_latency_then_handle_incoming(), set only at the beginning of either and equal to</span></div>
<div class="line"><a id="l01568" name="l01568"></a><span class="lineno"> 1568</span><span class="comment">   * `m_rcv_pending_acks.size()` at that time.  Because, for efficiency, individual acknowledgements are</span></div>
<div class="line"><a id="l01569" name="l01569"></a><span class="lineno"> 1569</span><span class="comment">   * accumulated over the course of those two methods, and an ACK with those acknowledgments is</span></div>
<div class="line"><a id="l01570" name="l01570"></a><span class="lineno"> 1570</span><span class="comment">   * sent at the end of that method (in perform_accumulated_on_recv_tasks()) at the earliest, this</span></div>
<div class="line"><a id="l01571" name="l01571"></a><span class="lineno"> 1571</span><span class="comment">   * member is used to determine whether we should start a delayed ACK timer at that point.</span></div>
<div class="line"><a id="l01572" name="l01572"></a><span class="lineno"> 1572</span><span class="comment">   *</span></div>
<div class="line"><a id="l01573" name="l01573"></a><span class="lineno"> 1573</span><span class="comment">   * This gains meaning only in thread W and only within Node::low_lvl_recv_and_handle()/etc.</span></div>
<div class="line"><a id="l01574" name="l01574"></a><span class="lineno"> 1574</span><span class="comment">   * and loses meaning after either method exits.  This should NOT</span></div>
<div class="line"><a id="l01575" name="l01575"></a><span class="lineno"> 1575</span><span class="comment">   * be accessed outside of thread W and is not protected by a mutex.</span></div>
<div class="line"><a id="l01576" name="l01576"></a><span class="lineno"> 1576</span><span class="comment">   */</span></div>
<div class="line"><a id="l01577" name="l01577"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a780f86759f861a3a84de8c5c768736b7"> 1577</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a780f86759f861a3a84de8c5c768736b7">m_rcv_pending_acks_size_at_recv_handler_start</a>;</div>
<div class="line"><a id="l01578" name="l01578"></a><span class="lineno"> 1578</span><span class="comment"></span> </div>
<div class="line"><a id="l01579" name="l01579"></a><span class="lineno"> 1579</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01580" name="l01580"></a><span class="lineno"> 1580</span><span class="comment">   * While Node::low_lvl_recv_and_handle() or async part of Node::async_wait_latency_then_handle_incoming() is running,</span></div>
<div class="line"><a id="l01581" name="l01581"></a><span class="lineno"> 1581</span><span class="comment">   * accumulates the individual acknowledgments contained in all incoming ACK low-level packets</span></div>
<div class="line"><a id="l01582" name="l01582"></a><span class="lineno"> 1582</span><span class="comment">   * received in those methods.  More precisely, this accumulates the elements of</span></div>
<div class="line"><a id="l01583" name="l01583"></a><span class="lineno"> 1583</span><span class="comment">   * `packet.m_rcv_acked_packets` for all packets such that `packet` is an Ack_packet.  They are accumulated</span></div>
<div class="line"><a id="l01584" name="l01584"></a><span class="lineno"> 1584</span><span class="comment">   * in this data structure for a similar reason that outgoing acknowledgments are accumulated in</span></div>
<div class="line"><a id="l01585" name="l01585"></a><span class="lineno"> 1585</span><span class="comment">   * `Peer_socket::m_rcv_pending_acks`.  The situation here is simpler, however, since the present</span></div>
<div class="line"><a id="l01586" name="l01586"></a><span class="lineno"> 1586</span><span class="comment">   * structure is always scanned and cleared at the end of the current handler and never carried</span></div>
<div class="line"><a id="l01587" name="l01587"></a><span class="lineno"> 1587</span><span class="comment">   * over to the next, as we always want to scan all individual acks received within a non-blocking</span></div>
<div class="line"><a id="l01588" name="l01588"></a><span class="lineno"> 1588</span><span class="comment">   * amount of time from receipt.  See Node::handle_ack_to_established() for details.</span></div>
<div class="line"><a id="l01589" name="l01589"></a><span class="lineno"> 1589</span><span class="comment">   *</span></div>
<div class="line"><a id="l01590" name="l01590"></a><span class="lineno"> 1590</span><span class="comment">   * This structure is empty, accumulated over the course of those methods, is used to finally scan</span></div>
<div class="line"><a id="l01591" name="l01591"></a><span class="lineno"> 1591</span><span class="comment">   * all individual acknowledgments (in the exact order received), and then cleared for the next</span></div>
<div class="line"><a id="l01592" name="l01592"></a><span class="lineno"> 1592</span><span class="comment">   * run.</span></div>
<div class="line"><a id="l01593" name="l01593"></a><span class="lineno"> 1593</span><span class="comment">   *</span></div>
<div class="line"><a id="l01594" name="l01594"></a><span class="lineno"> 1594</span><span class="comment">   * Storing shared pointers to avoid copying of structs (however small) during internal</span></div>
<div class="line"><a id="l01595" name="l01595"></a><span class="lineno"> 1595</span><span class="comment">   * reshuffling; shared instead of raw pointers to not worry about delete.</span></div>
<div class="line"><a id="l01596" name="l01596"></a><span class="lineno"> 1596</span><span class="comment">   *</span></div>
<div class="line"><a id="l01597" name="l01597"></a><span class="lineno"> 1597</span><span class="comment">   * This gains meaning only in thread W and only within Node::low_lvl_recv_and_handle()/etc.</span></div>
<div class="line"><a id="l01598" name="l01598"></a><span class="lineno"> 1598</span><span class="comment">   * and loses meaning after either method exits.  This should NOT</span></div>
<div class="line"><a id="l01599" name="l01599"></a><span class="lineno"> 1599</span><span class="comment">   * be accessed outside of thread W and is not protected by a mutex.</span></div>
<div class="line"><a id="l01600" name="l01600"></a><span class="lineno"> 1600</span><span class="comment">   */</span></div>
<div class="line"><a id="l01601" name="l01601"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a8229396adfd306d15e8a05dac3fe8c29"> 1601</a></span>  std::vector&lt;Ack_packet::Individual_ack::Ptr&gt; <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a8229396adfd306d15e8a05dac3fe8c29">m_rcv_acked_packets</a>;</div>
<div class="line"><a id="l01602" name="l01602"></a><span class="lineno"> 1602</span><span class="comment"></span> </div>
<div class="line"><a id="l01603" name="l01603"></a><span class="lineno"> 1603</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01604" name="l01604"></a><span class="lineno"> 1604</span><span class="comment">   * While Node::low_lvl_recv_and_handle() or async part of Node::async_wait_latency_then_handle_incoming() is running,</span></div>
<div class="line"><a id="l01605" name="l01605"></a><span class="lineno"> 1605</span><span class="comment">   * contains the rcv_wnd (eventual #m_snd_remote_rcv_wnd) value in the last observed ACK low-level</span></div>
<div class="line"><a id="l01606" name="l01606"></a><span class="lineno"> 1606</span><span class="comment">   * packet received in those methods.  The reasoning is similar to #m_rcv_acked_packets.  See</span></div>
<div class="line"><a id="l01607" name="l01607"></a><span class="lineno"> 1607</span><span class="comment">   * Node::handle_ack_to_established() for details.</span></div>
<div class="line"><a id="l01608" name="l01608"></a><span class="lineno"> 1608</span><span class="comment">   *</span></div>
<div class="line"><a id="l01609" name="l01609"></a><span class="lineno"> 1609</span><span class="comment">   * This gains meaning only in thread W and only within Node::low_lvl_recv_and_handle()/etc.</span></div>
<div class="line"><a id="l01610" name="l01610"></a><span class="lineno"> 1610</span><span class="comment">   * and loses meaning after either method exits.  This should NOT</span></div>
<div class="line"><a id="l01611" name="l01611"></a><span class="lineno"> 1611</span><span class="comment">   * be accessed outside of thread W and is not protected by a mutex.</span></div>
<div class="line"><a id="l01612" name="l01612"></a><span class="lineno"> 1612</span><span class="comment">   */</span></div>
<div class="line"><a id="l01613" name="l01613"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a07d885e5c8ec85e7ef8718dc0468ffe9"> 1613</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a07d885e5c8ec85e7ef8718dc0468ffe9">m_snd_pending_rcv_wnd</a>;</div>
<div class="line"><a id="l01614" name="l01614"></a><span class="lineno"> 1614</span><span class="comment"></span> </div>
<div class="line"><a id="l01615" name="l01615"></a><span class="lineno"> 1615</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01616" name="l01616"></a><span class="lineno"> 1616</span><span class="comment">   * The last rcv_wnd value sent to the other side (in an ACK).  This is used to gauge how much the</span></div>
<div class="line"><a id="l01617" name="l01617"></a><span class="lineno"> 1617</span><span class="comment">   * true rcv_wnd has increased since the value that the sender probably (assuming ACK was not lost)</span></div>
<div class="line"><a id="l01618" name="l01618"></a><span class="lineno"> 1618</span><span class="comment">   * knows.</span></div>
<div class="line"><a id="l01619" name="l01619"></a><span class="lineno"> 1619</span><span class="comment">   *</span></div>
<div class="line"><a id="l01620" name="l01620"></a><span class="lineno"> 1620</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01621" name="l01621"></a><span class="lineno"> 1621</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01622" name="l01622"></a><span class="lineno"> 1622</span><span class="comment">   */</span></div>
<div class="line"><a id="l01623" name="l01623"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a7fa76b609ef0aa5962d8de77338cf9ee"> 1623</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a7fa76b609ef0aa5962d8de77338cf9ee">m_rcv_last_sent_rcv_wnd</a>;</div>
<div class="line"><a id="l01624" name="l01624"></a><span class="lineno"> 1624</span><span class="comment"></span> </div>
<div class="line"><a id="l01625" name="l01625"></a><span class="lineno"> 1625</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01626" name="l01626"></a><span class="lineno"> 1626</span><span class="comment">   * `true` indicates we are in a state where we&#39;ve decided other side needs to be informed that</span></div>
<div class="line"><a id="l01627" name="l01627"></a><span class="lineno"> 1627</span><span class="comment">   * our receive window has increased substantially, so that it can resume sending data (probably</span></div>
<div class="line"><a id="l01628" name="l01628"></a><span class="lineno"> 1628</span><span class="comment">   * after a zero window being advertised).</span></div>
<div class="line"><a id="l01629" name="l01629"></a><span class="lineno"> 1629</span><span class="comment">   *</span></div>
<div class="line"><a id="l01630" name="l01630"></a><span class="lineno"> 1630</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01631" name="l01631"></a><span class="lineno"> 1631</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01632" name="l01632"></a><span class="lineno"> 1632</span><span class="comment">   */</span></div>
<div class="line"><a id="l01633" name="l01633"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ad7414dfca4b869dd3a4e0de39195c69e"> 1633</a></span>  <span class="keywordtype">bool</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ad7414dfca4b869dd3a4e0de39195c69e">m_rcv_in_rcv_wnd_recovery</a>;</div>
<div class="line"><a id="l01634" name="l01634"></a><span class="lineno"> 1634</span><span class="comment"></span> </div>
<div class="line"><a id="l01635" name="l01635"></a><span class="lineno"> 1635</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01636" name="l01636"></a><span class="lineno"> 1636</span><span class="comment">   * Time point at which #m_rcv_in_rcv_wnd_recovery was last set to true.  It is only used when the</span></div>
<div class="line"><a id="l01637" name="l01637"></a><span class="lineno"> 1637</span><span class="comment">   * latter is indeed true.</span></div>
<div class="line"><a id="l01638" name="l01638"></a><span class="lineno"> 1638</span><span class="comment">   *</span></div>
<div class="line"><a id="l01639" name="l01639"></a><span class="lineno"> 1639</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01640" name="l01640"></a><span class="lineno"> 1640</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01641" name="l01641"></a><span class="lineno"> 1641</span><span class="comment">   */</span></div>
<div class="line"><a id="l01642" name="l01642"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a5476d9206f997fc9119b2a80b078ee87"> 1642</a></span>  <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a5476d9206f997fc9119b2a80b078ee87">m_rcv_wnd_recovery_start_time</a>;</div>
<div class="line"><a id="l01643" name="l01643"></a><span class="lineno"> 1643</span><span class="comment"></span> </div>
<div class="line"><a id="l01644" name="l01644"></a><span class="lineno"> 1644</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01645" name="l01645"></a><span class="lineno"> 1645</span><span class="comment">   * When #m_rcv_in_rcv_wnd_recovery is `true`, this is the scheduled task to possibly</span></div>
<div class="line"><a id="l01646" name="l01646"></a><span class="lineno"> 1646</span><span class="comment">   * send another unsolicited rcv_wnd-advertising ACK to the other side.</span></div>
<div class="line"><a id="l01647" name="l01647"></a><span class="lineno"> 1647</span><span class="comment">   *</span></div>
<div class="line"><a id="l01648" name="l01648"></a><span class="lineno"> 1648</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01649" name="l01649"></a><span class="lineno"> 1649</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01650" name="l01650"></a><span class="lineno"> 1650</span><span class="comment">   */</span></div>
<div class="line"><a id="l01651" name="l01651"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#afd590cc70d06b8e903027e4924fd095a"> 1651</a></span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">util::Scheduled_task_handle</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#afd590cc70d06b8e903027e4924fd095a">m_rcv_wnd_recovery_scheduled_task</a>;</div>
<div class="line"><a id="l01652" name="l01652"></a><span class="lineno"> 1652</span><span class="comment"></span> </div>
<div class="line"><a id="l01653" name="l01653"></a><span class="lineno"> 1653</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01654" name="l01654"></a><span class="lineno"> 1654</span><span class="comment">   * Timer started, assuming delayed ACKs are enabled, when the first Individual_ack is placed onto</span></div>
<div class="line"><a id="l01655" name="l01655"></a><span class="lineno"> 1655</span><span class="comment">   * an empty #m_rcv_pending_acks; when it triggers, the pending individual acknowledgments are packed</span></div>
<div class="line"><a id="l01656" name="l01656"></a><span class="lineno"> 1656</span><span class="comment">   * into as few as possible ACKs and sent to the other side.  After the handler exits</span></div>
<div class="line"><a id="l01657" name="l01657"></a><span class="lineno"> 1657</span><span class="comment">   * #m_rcv_pending_acks is again empty and the process can repeat starting with the next received valid</span></div>
<div class="line"><a id="l01658" name="l01658"></a><span class="lineno"> 1658</span><span class="comment">   * packet.</span></div>
<div class="line"><a id="l01659" name="l01659"></a><span class="lineno"> 1659</span><span class="comment">   *</span></div>
<div class="line"><a id="l01660" name="l01660"></a><span class="lineno"> 1660</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01661" name="l01661"></a><span class="lineno"> 1661</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01662" name="l01662"></a><span class="lineno"> 1662</span><span class="comment">   *</span></div>
<div class="line"><a id="l01663" name="l01663"></a><span class="lineno"> 1663</span><span class="comment">   * ### Implementation notes ###</span></div>
<div class="line"><a id="l01664" name="l01664"></a><span class="lineno"> 1664</span><span class="comment">   * In other places we have tended to replace a `Timer` with the far simpler util::schedule_task_from_now() (etc.)</span></div>
<div class="line"><a id="l01665" name="l01665"></a><span class="lineno"> 1665</span><span class="comment">   * facility (which internally uses a `Timer` but hides its various annoyances and caveats).  Why not here?</span></div>
<div class="line"><a id="l01666" name="l01666"></a><span class="lineno"> 1666</span><span class="comment">   * Answer: This timer is scheduled and fires often (could be on the order of every 1-500 milliseconds) and throughout</span></div>
<div class="line"><a id="l01667" name="l01667"></a><span class="lineno"> 1667</span><span class="comment">   * a given socket&#39;s existence; hence the potential performance effects aren&#39;t worth the risk (or at least mental</span></div>
<div class="line"><a id="l01668" name="l01668"></a><span class="lineno"> 1668</span><span class="comment">   * energy spent on evaluating that risk, originally and over time).  The conservative thing to do is reuse a single</span></div>
<div class="line"><a id="l01669" name="l01669"></a><span class="lineno"> 1669</span><span class="comment">   * `Timer` repeatedly, as we do here.</span></div>
<div class="line"><a id="l01670" name="l01670"></a><span class="lineno"> 1670</span><span class="comment">   */</span></div>
<div class="line"><a id="l01671" name="l01671"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a88f967e74f8618c94088113e918ab52f"> 1671</a></span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#ae7416d64d2989051104bb396e28e15e6">util::Timer</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a88f967e74f8618c94088113e918ab52f">m_rcv_delayed_ack_timer</a>;</div>
<div class="line"><a id="l01672" name="l01672"></a><span class="lineno"> 1672</span><span class="comment"></span> </div>
<div class="line"><a id="l01673" name="l01673"></a><span class="lineno"> 1673</span><span class="comment">  /// Stats regarding incoming traffic (and resulting outgoing ACKs) for this connection so far.</span></div>
<div class="line"><a id="l01674" name="l01674"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a7d1f1d381749473f7a2471b8be20d6a8"> 1674</a></span><span class="comment"></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Peer__socket__receive__stats__accumulator.html">Peer_socket_receive_stats_accumulator</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a7d1f1d381749473f7a2471b8be20d6a8">m_rcv_stats</a>;</div>
<div class="line"><a id="l01675" name="l01675"></a><span class="lineno"> 1675</span><span class="comment"></span> </div>
<div class="line"><a id="l01676" name="l01676"></a><span class="lineno"> 1676</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01677" name="l01677"></a><span class="lineno"> 1677</span><span class="comment">   * The Initial Sequence Number (ISN) used in our original SYN or SYN_ACK.  Useful at least in re-sending the</span></div>
<div class="line"><a id="l01678" name="l01678"></a><span class="lineno"> 1678</span><span class="comment">   * original SYN or SYN_ACK if unacknowledged for too long.</span></div>
<div class="line"><a id="l01679" name="l01679"></a><span class="lineno"> 1679</span><span class="comment">   *</span></div>
<div class="line"><a id="l01680" name="l01680"></a><span class="lineno"> 1680</span><span class="comment">   * @see #m_snd_flying_pkts_by_seq_num and #m_snd_flying_pkts_by_sent_when.</span></div>
<div class="line"><a id="l01681" name="l01681"></a><span class="lineno"> 1681</span><span class="comment">   *</span></div>
<div class="line"><a id="l01682" name="l01682"></a><span class="lineno"> 1682</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01683" name="l01683"></a><span class="lineno"> 1683</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01684" name="l01684"></a><span class="lineno"> 1684</span><span class="comment">   */</span></div>
<div class="line"><a id="l01685" name="l01685"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#aca66d1cb582ca027745d1ef847266cc4"> 1685</a></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Sequence__number.html">Sequence_number</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#aca66d1cb582ca027745d1ef847266cc4">m_snd_init_seq_num</a>;</div>
<div class="line"><a id="l01686" name="l01686"></a><span class="lineno"> 1686</span><span class="comment"></span> </div>
<div class="line"><a id="l01687" name="l01687"></a><span class="lineno"> 1687</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01688" name="l01688"></a><span class="lineno"> 1688</span><span class="comment">   * The sequence number for the start of the data in the next new DATA packet to be sent out.  By</span></div>
<div class="line"><a id="l01689" name="l01689"></a><span class="lineno"> 1689</span><span class="comment">   * &quot;new&quot; I mean not-retransmitted (assuming retransmission is even enabled).</span></div>
<div class="line"><a id="l01690" name="l01690"></a><span class="lineno"> 1690</span><span class="comment">   *</span></div>
<div class="line"><a id="l01691" name="l01691"></a><span class="lineno"> 1691</span><span class="comment">   * @todo Possibly #m_snd_next_seq_num will apply to other packet types than DATA, probably anything to do with</span></div>
<div class="line"><a id="l01692" name="l01692"></a><span class="lineno"> 1692</span><span class="comment">   * connection termination.</span></div>
<div class="line"><a id="l01693" name="l01693"></a><span class="lineno"> 1693</span><span class="comment">   *</span></div>
<div class="line"><a id="l01694" name="l01694"></a><span class="lineno"> 1694</span><span class="comment">   * @see #m_snd_flying_pkts_by_seq_num and #m_snd_flying_pkts_by_sent_when.</span></div>
<div class="line"><a id="l01695" name="l01695"></a><span class="lineno"> 1695</span><span class="comment">   *</span></div>
<div class="line"><a id="l01696" name="l01696"></a><span class="lineno"> 1696</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01697" name="l01697"></a><span class="lineno"> 1697</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01698" name="l01698"></a><span class="lineno"> 1698</span><span class="comment">   */</span></div>
<div class="line"><a id="l01699" name="l01699"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a1f8bebf649551131e6ed6e75c6f98d54"> 1699</a></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Sequence__number.html">Sequence_number</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a1f8bebf649551131e6ed6e75c6f98d54">m_snd_next_seq_num</a>;</div>
<div class="line"><a id="l01700" name="l01700"></a><span class="lineno"> 1700</span><span class="comment"></span> </div>
<div class="line"><a id="l01701" name="l01701"></a><span class="lineno"> 1701</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01702" name="l01702"></a><span class="lineno"> 1702</span><span class="comment">   * The collection of all In-flight packets, indexed by sequence number and ordered from most to</span></div>
<div class="line"><a id="l01703" name="l01703"></a><span class="lineno"> 1703</span><span class="comment">   * least recently sent (including those queued up to wire-send in pacing module).  See also</span></div>
<div class="line"><a id="l01704" name="l01704"></a><span class="lineno"> 1704</span><span class="comment">   * #m_snd_flying_pkts_by_seq_num which is a similar map but in order of sequence number.</span></div>
<div class="line"><a id="l01705" name="l01705"></a><span class="lineno"> 1705</span><span class="comment">   * That map&#39;s keys are again sequence numbers, but its values are iterators into the present map</span></div>
<div class="line"><a id="l01706" name="l01706"></a><span class="lineno"> 1706</span><span class="comment">   * to save memory and avoid having to sync up data between the two (the only thing we must sync between them</span></div>
<div class="line"><a id="l01707" name="l01707"></a><span class="lineno"> 1707</span><span class="comment">   * are their key sets). The two maps together can be considered to be the sender-side &quot;scoreboard.&quot;</span></div>
<div class="line"><a id="l01708" name="l01708"></a><span class="lineno"> 1708</span><span class="comment">   *</span></div>
<div class="line"><a id="l01709" name="l01709"></a><span class="lineno"> 1709</span><span class="comment">   * These are all the packets that have been sent but not Acknowledged that we have not yet considered</span></div>
<div class="line"><a id="l01710" name="l01710"></a><span class="lineno"> 1710</span><span class="comment">   * Dropped.  (With retransmission on, packets are never considered</span></div>
<div class="line"><a id="l01711" name="l01711"></a><span class="lineno"> 1711</span><span class="comment">   * permanently Dropped, but they are considered Dropped until retransmitted.)  With retransmission</span></div>
<div class="line"><a id="l01712" name="l01712"></a><span class="lineno"> 1712</span><span class="comment">   * off, the ultimate goal of having this structure at all is to handle ACKs, the ultimate goal of</span></div>
<div class="line"><a id="l01713" name="l01713"></a><span class="lineno"> 1713</span><span class="comment">   * which is, in turn, for the In-flight vs. Congestion Window comparison for congestion control.</span></div>
<div class="line"><a id="l01714" name="l01714"></a><span class="lineno"> 1714</span><span class="comment">   * With retransmission on, the structure additionally stores the data in the In-flight packets, so</span></div>
<div class="line"><a id="l01715" name="l01715"></a><span class="lineno"> 1715</span><span class="comment">   * that they can be retransmitted if we determine they were probably dropped.</span></div>
<div class="line"><a id="l01716" name="l01716"></a><span class="lineno"> 1716</span><span class="comment">   *</span></div>
<div class="line"><a id="l01717" name="l01717"></a><span class="lineno"> 1717</span><span class="comment">   * With retransmission on, this is NOT the retransmission queue itself -- i.e., this does NOT</span></div>
<div class="line"><a id="l01718" name="l01718"></a><span class="lineno"> 1718</span><span class="comment">   * store packet data that we know should be retransmitted when possible but rather only the data</span></div>
<div class="line"><a id="l01719" name="l01719"></a><span class="lineno"> 1719</span><span class="comment">   * already In-flight (whether from first attempt or from retransmission).</span></div>
<div class="line"><a id="l01720" name="l01720"></a><span class="lineno"> 1720</span><span class="comment">   *</span></div>
<div class="line"><a id="l01721" name="l01721"></a><span class="lineno"> 1721</span><span class="comment">   * Please see #m_snd_flying_pkts_by_seq_num for a breakdown of the sequence number space.</span></div>
<div class="line"><a id="l01722" name="l01722"></a><span class="lineno"> 1722</span><span class="comment">   * Since that structure contains iterators to exactly the values in the present map, that comment will</span></div>
<div class="line"><a id="l01723" name="l01723"></a><span class="lineno"> 1723</span><span class="comment">   * explain which packets are in the present map.</span></div>
<div class="line"><a id="l01724" name="l01724"></a><span class="lineno"> 1724</span><span class="comment">   *</span></div>
<div class="line"><a id="l01725" name="l01725"></a><span class="lineno"> 1725</span><span class="comment">   * #m_snd_flying_pkts_by_sent_when contains In-flight Sent_packet objects as values, with each particular</span></div>
<div class="line"><a id="l01726" name="l01726"></a><span class="lineno"> 1726</span><span class="comment">   * Sent_packet&#39;s first sequence number as its key.  If there are no In-flight Sent_packet objects, then</span></div>
<div class="line"><a id="l01727" name="l01727"></a><span class="lineno"> 1727</span><span class="comment">   * `m_snd_flying_pkts_by_sent_when.empty()`.</span></div>
<div class="line"><a id="l01728" name="l01728"></a><span class="lineno"> 1728</span><span class="comment">   *</span></div>
<div class="line"><a id="l01729" name="l01729"></a><span class="lineno"> 1729</span><span class="comment">   * The above is an invariant, to be true at the end of each boost.asio handler in thread W, at</span></div>
<div class="line"><a id="l01730" name="l01730"></a><span class="lineno"> 1730</span><span class="comment">   * least.</span></div>
<div class="line"><a id="l01731" name="l01731"></a><span class="lineno"> 1731</span><span class="comment">   *</span></div>
<div class="line"><a id="l01732" name="l01732"></a><span class="lineno"> 1732</span><span class="comment">   * Each sent packet therefore is placed into #m_snd_flying_pkts_by_sent_when, at the front (as is standard</span></div>
<div class="line"><a id="l01733" name="l01733"></a><span class="lineno"> 1733</span><span class="comment">   * for a Linked_hash_map, and as is expected, since they are ordered by send time).  (Note, however,</span></div>
<div class="line"><a id="l01734" name="l01734"></a><span class="lineno"> 1734</span><span class="comment">   * that being in this map does not mean it has been sent; it may only be queued up to be sent and</span></div>
<div class="line"><a id="l01735" name="l01735"></a><span class="lineno"> 1735</span><span class="comment">   * waiting in the pacing module; however, pacing does not change the order of packets but merely</span></div>
<div class="line"><a id="l01736" name="l01736"></a><span class="lineno"> 1736</span><span class="comment">   * the exact send moment, which cannot change the position in this queue.)</span></div>
<div class="line"><a id="l01737" name="l01737"></a><span class="lineno"> 1737</span><span class="comment">   * When a packet is Acknowledged, it is removed from #m_snd_flying_pkts_by_sent_when -- could be from anywhere</span></div>
<div class="line"><a id="l01738" name="l01738"></a><span class="lineno"> 1738</span><span class="comment">   * in the ordering.   Similarly to Acknowledged packets, Dropped ones are also removed.</span></div>
<div class="line"><a id="l01739" name="l01739"></a><span class="lineno"> 1739</span><span class="comment">   *</span></div>
<div class="line"><a id="l01740" name="l01740"></a><span class="lineno"> 1740</span><span class="comment">   * The type used is a map indexed by starting sequence number of each packet but also in order of</span></div>
<div class="line"><a id="l01741" name="l01741"></a><span class="lineno"> 1741</span><span class="comment">   * being sent out.  Lookup by sequence number is near constant time; insertion near the end is</span></div>
<div class="line"><a id="l01742" name="l01742"></a><span class="lineno"> 1742</span><span class="comment">   * near constant time; and iteration by order of when it was sent out is easy/fast, with iterators</span></div>
<div class="line"><a id="l01743" name="l01743"></a><span class="lineno"> 1743</span><span class="comment">   * remaining valid as long as the underlying elements are not erased.  Why use this particular</span></div>
<div class="line"><a id="l01744" name="l01744"></a><span class="lineno"> 1744</span><span class="comment">   * structure?  Well, the lookup by sequence number occurs all the time, such as when matching up</span></div>
<div class="line"><a id="l01745" name="l01745"></a><span class="lineno"> 1745</span><span class="comment">   * an arriving acknowledgment against a packet that we&#39;d sent out.  We&#39;d prefer it to not invalidate</span></div>
<div class="line"><a id="l01746" name="l01746"></a><span class="lineno"> 1746</span><span class="comment">   * iterators when something is erased, so Linked_hash_map is good in that way</span></div>
<div class="line"><a id="l01747" name="l01747"></a><span class="lineno"> 1747</span><span class="comment">   * also.  So finally, why order by time it was queued up for sending (as opposed to by sequence</span></div>
<div class="line"><a id="l01748" name="l01748"></a><span class="lineno"> 1748</span><span class="comment">   * number, as would be the case if this were an std::map)?  In truth, both are needed, which is why</span></div>
<div class="line"><a id="l01749" name="l01749"></a><span class="lineno"> 1749</span><span class="comment">   * #m_snd_flying_pkts_by_seq_num exists.  This ordering is needed particularly for the</span></div>
<div class="line"><a id="l01750" name="l01750"></a><span class="lineno"> 1750</span><span class="comment">   * `m_acks_after_me` logic, wherein we count how many times packets that were sent after a given packet</span></div>
<div class="line"><a id="l01751" name="l01751"></a><span class="lineno"> 1751</span><span class="comment">   * have been acknowledged so far; by arranging the packets in that same order, that value can be</span></div>
<div class="line"><a id="l01752" name="l01752"></a><span class="lineno"> 1752</span><span class="comment">   * easily and quickly accumulated by walking back from the most recently sent packet.  On the other</span></div>
<div class="line"><a id="l01753" name="l01753"></a><span class="lineno"> 1753</span><span class="comment">   * hand, some operations need sequence number ordering, which is why we have #m_snd_flying_pkts_by_seq_num;</span></div>
<div class="line"><a id="l01754" name="l01754"></a><span class="lineno"> 1754</span><span class="comment">   * note (again) that the two maps have the same key set, with one&#39;s values being iterators pointing into</span></div>
<div class="line"><a id="l01755" name="l01755"></a><span class="lineno"> 1755</span><span class="comment">   * the other.</span></div>
<div class="line"><a id="l01756" name="l01756"></a><span class="lineno"> 1756</span><span class="comment">   *</span></div>
<div class="line"><a id="l01757" name="l01757"></a><span class="lineno"> 1757</span><span class="comment">   * Whenever a packet with `m_sent_when.back().m_sent_time == T` is acknowledged, we need to (by definition of</span></div>
<div class="line"><a id="l01758" name="l01758"></a><span class="lineno"> 1758</span><span class="comment">   * Sent_packet::m_acks_after_me) increment `m_acks_after_me` for each packet with</span></div>
<div class="line"><a id="l01759" name="l01759"></a><span class="lineno"> 1759</span><span class="comment">   * `m_sent_when.back().m_sent_time &lt; T`.  So, if we</span></div>
<div class="line"><a id="l01760" name="l01760"></a><span class="lineno"> 1760</span><span class="comment">   * find the latest-sent element that satisfies that, then all packets appearing to the right</span></div>
<div class="line"><a id="l01761" name="l01761"></a><span class="lineno"> 1761</span><span class="comment">   * (i.e., &quot;sent less recently than&quot;) and including that one, in this ordering, should have `m_acks_after_me`</span></div>
<div class="line"><a id="l01762" name="l01762"></a><span class="lineno"> 1762</span><span class="comment">   * incremented.  Using a certain priority queue-using algorithm (see Node::handle_accumulated_acks())</span></div>
<div class="line"><a id="l01763" name="l01763"></a><span class="lineno"> 1763</span><span class="comment">   * we can do this quite efficiently.</span></div>
<div class="line"><a id="l01764" name="l01764"></a><span class="lineno"> 1764</span><span class="comment">   *</span></div>
<div class="line"><a id="l01765" name="l01765"></a><span class="lineno"> 1765</span><span class="comment">   * Note that this means Sent_packet::m_acks_after_me is strictly increasing as one walks this map.</span></div>
<div class="line"><a id="l01766" name="l01766"></a><span class="lineno"> 1766</span><span class="comment">   *</span></div>
<div class="line"><a id="l01767" name="l01767"></a><span class="lineno"> 1767</span><span class="comment">   * Since any packet with `m_acks_after_me &gt;= C`, where `C` is some constant, is considered Dropped and</span></div>
<div class="line"><a id="l01768" name="l01768"></a><span class="lineno"> 1768</span><span class="comment">   * removed from #m_snd_flying_pkts_by_seq_num and therefore this map also, we also get the property that</span></div>
<div class="line"><a id="l01769" name="l01769"></a><span class="lineno"> 1769</span><span class="comment">   * if we find a packet in this map for which that is true, then it is also true for all packets</span></div>
<div class="line"><a id="l01770" name="l01770"></a><span class="lineno"> 1770</span><span class="comment">   * following it (&quot;sent less recently&quot; than it) in this map.  This allows us to more quickly determine which</span></div>
<div class="line"><a id="l01771" name="l01771"></a><span class="lineno"> 1771</span><span class="comment">   * packets should be removed from #m_snd_flying_pkts_by_sent_when, without having to walk the entire structure(s).</span></div>
<div class="line"><a id="l01772" name="l01772"></a><span class="lineno"> 1772</span><span class="comment">   *</span></div>
<div class="line"><a id="l01773" name="l01773"></a><span class="lineno"> 1773</span><span class="comment">   * ### Memory use ###</span></div>
<div class="line"><a id="l01774" name="l01774"></a><span class="lineno"> 1774</span><span class="comment">   * This structure&#39;s memory use is naturally bounded by the Congestion Window.</span></div>
<div class="line"><a id="l01775" name="l01775"></a><span class="lineno"> 1775</span><span class="comment">   * Congestion control will not let it grow beyond that many packets (bytes really, but you get the point).</span></div>
<div class="line"><a id="l01776" name="l01776"></a><span class="lineno"> 1776</span><span class="comment">   * At that point blocks will stay on the Send buffer, until that fills up too.  Then send() will refuse to enqueue</span></div>
<div class="line"><a id="l01777" name="l01777"></a><span class="lineno"> 1777</span><span class="comment">   * any more packets (telling the user as much).</span></div>
<div class="line"><a id="l01778" name="l01778"></a><span class="lineno"> 1778</span><span class="comment">   *</span></div>
<div class="line"><a id="l01779" name="l01779"></a><span class="lineno"> 1779</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l01780" name="l01780"></a><span class="lineno"> 1780</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01781" name="l01781"></a><span class="lineno"> 1781</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01782" name="l01782"></a><span class="lineno"> 1782</span><span class="comment">   *</span></div>
<div class="line"><a id="l01783" name="l01783"></a><span class="lineno"> 1783</span><span class="comment">   * @see Sent_when and Sent_packet::m_sent_when, where if `X` is the the last element of the latter sequence, then</span></div>
<div class="line"><a id="l01784" name="l01784"></a><span class="lineno"> 1784</span><span class="comment">   *      `X.m_sent_time` is the value by which elements in the present map are ordered.  However, this only</span></div>
<div class="line"><a id="l01785" name="l01785"></a><span class="lineno"> 1785</span><span class="comment">   *      happens to be the case, because by definition an element</span></div>
<div class="line"><a id="l01786" name="l01786"></a><span class="lineno"> 1786</span><span class="comment">   *      is always placed at the front of the present map (Linked_hash_map), and this order is inductively maintained;</span></div>
<div class="line"><a id="l01787" name="l01787"></a><span class="lineno"> 1787</span><span class="comment">   *      AND MEANWHILE A Sent_when::m_sent_time&#39;s constructed value can only increase over time (which is a guaranteed</span></div>
<div class="line"><a id="l01788" name="l01788"></a><span class="lineno"> 1788</span><span class="comment">   *      property of the clock we use (::Fine_clock)).</span></div>
<div class="line"><a id="l01789" name="l01789"></a><span class="lineno"> 1789</span><span class="comment">   * @see #m_snd_flying_bytes, which must always be updated to be accurate w/r/t</span></div>
<div class="line"><a id="l01790" name="l01790"></a><span class="lineno"> 1790</span><span class="comment">   *      #m_snd_flying_pkts_by_sent_when.  Use Node::snd_flying_pkts_updated() whenever</span></div>
<div class="line"><a id="l01791" name="l01791"></a><span class="lineno"> 1791</span><span class="comment">   *      #m_snd_flying_pkts_by_sent_when is changed.</span></div>
<div class="line"><a id="l01792" name="l01792"></a><span class="lineno"> 1792</span><span class="comment">   * @see #m_snd_flying_pkts_by_seq_num, which provides an ordering of the elements of</span></div>
<div class="line"><a id="l01793" name="l01793"></a><span class="lineno"> 1793</span><span class="comment">   *      #m_snd_flying_pkts_by_sent_when by sequence number.  Whereas the present structure is used to</span></div>
<div class="line"><a id="l01794" name="l01794"></a><span class="lineno"> 1794</span><span class="comment">   *      determine `m_acks_after_me` (since logically &quot;after&quot; means &quot;sent after&quot;), `..._by_seq_num`</span></div>
<div class="line"><a id="l01795" name="l01795"></a><span class="lineno"> 1795</span><span class="comment">   *      is akin to the more classic TCP scoreboard, which is used to subdivide the sequence number</span></div>
<div class="line"><a id="l01796" name="l01796"></a><span class="lineno"> 1796</span><span class="comment">   *      space (closely related to #m_snd_next_seq_num and such).  With</span></div>
<div class="line"><a id="l01797" name="l01797"></a><span class="lineno"> 1797</span><span class="comment">   *      retransmission off, &quot;after&quot; would simply mean &quot;having higher sequence number,&quot; so</span></div>
<div class="line"><a id="l01798" name="l01798"></a><span class="lineno"> 1798</span><span class="comment">   *      #m_snd_flying_pkts_by_sent_when would already provide this ordering, but with retransmission on</span></div>
<div class="line"><a id="l01799" name="l01799"></a><span class="lineno"> 1799</span><span class="comment">   *      a retransmitted packet with a lower number could be sent after one with a higher number.</span></div>
<div class="line"><a id="l01800" name="l01800"></a><span class="lineno"> 1800</span><span class="comment">   *      To make the code simpler, we therefore rely on a separate structure in either situation.</span></div>
<div class="line"><a id="l01801" name="l01801"></a><span class="lineno"> 1801</span><span class="comment">   */</span></div>
<div class="line"><a id="l01802" name="l01802"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a5ea56c54a98289211fef4a672432a2ad"> 1802</a></span>  <a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__map.html">Sent_pkt_by_sent_when_map</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a5ea56c54a98289211fef4a672432a2ad">m_snd_flying_pkts_by_sent_when</a>;</div>
<div class="line"><a id="l01803" name="l01803"></a><span class="lineno"> 1803</span><span class="comment"></span> </div>
<div class="line"><a id="l01804" name="l01804"></a><span class="lineno"> 1804</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01805" name="l01805"></a><span class="lineno"> 1805</span><span class="comment">   * The collection of all In-flight packets (including those queued up to send in pacing module),</span></div>
<div class="line"><a id="l01806" name="l01806"></a><span class="lineno"> 1806</span><span class="comment">   * indexed AND ordered by sequence number.  See also #m_snd_flying_pkts_by_sent_when which is a similar map</span></div>
<div class="line"><a id="l01807" name="l01807"></a><span class="lineno"> 1807</span><span class="comment">   * but in order of time sent.  Our map&#39;s keys are sequence numbers again, but its values are iterators</span></div>
<div class="line"><a id="l01808" name="l01808"></a><span class="lineno"> 1808</span><span class="comment">   * into #m_snd_flying_pkts_by_sent_when to save memory and avoid having to sync up data between the two</span></div>
<div class="line"><a id="l01809" name="l01809"></a><span class="lineno"> 1809</span><span class="comment">   * (only keys are in sync).  The two maps together can be considered to be the &quot;scoreboard,&quot; though in fact</span></div>
<div class="line"><a id="l01810" name="l01810"></a><span class="lineno"> 1810</span><span class="comment">   * the present structure alone is closer to a classic TCP scoreboard.</span></div>
<div class="line"><a id="l01811" name="l01811"></a><span class="lineno"> 1811</span><span class="comment">   *</span></div>
<div class="line"><a id="l01812" name="l01812"></a><span class="lineno"> 1812</span><span class="comment">   * The key sets of the two maps are identical.  The values in this map are iterators to exactly all</span></div>
<div class="line"><a id="l01813" name="l01813"></a><span class="lineno"> 1813</span><span class="comment">   * elements of #m_snd_flying_pkts_by_sent_when.  One can think of the present map as essentially achieving an</span></div>
<div class="line"><a id="l01814" name="l01814"></a><span class="lineno"> 1814</span><span class="comment">   * alternate ordering of the values in the other map.</span></div>
<div class="line"><a id="l01815" name="l01815"></a><span class="lineno"> 1815</span><span class="comment">   *</span></div>
<div class="line"><a id="l01816" name="l01816"></a><span class="lineno"> 1816</span><span class="comment">   * That said, the structure&#39;s contents and ordering are closely related to a breakdown of the sequence</span></div>
<div class="line"><a id="l01817" name="l01817"></a><span class="lineno"> 1817</span><span class="comment">   * number space.  I provide this breakdown here.  I list the</span></div>
<div class="line"><a id="l01818" name="l01818"></a><span class="lineno"> 1818</span><span class="comment">   * sequence number ranges in increasing order starting with the ISN.  Let `first_flying_seq_num</span></div>
<div class="line"><a id="l01819" name="l01819"></a><span class="lineno"> 1819</span><span class="comment">   * = m_snd_flying_pkts_by_seq_num.begin()-&gt;first` (i.e., the first key Sequence_number in</span></div>
<div class="line"><a id="l01820" name="l01820"></a><span class="lineno"> 1820</span><span class="comment">   * #m_snd_flying_pkts_by_seq_num) for exposition purposes.</span></div>
<div class="line"><a id="l01821" name="l01821"></a><span class="lineno"> 1821</span><span class="comment">   *</span></div>
<div class="line"><a id="l01822" name="l01822"></a><span class="lineno"> 1822</span><span class="comment">   *   - #m_snd_init_seq_num =</span></div>
<div class="line"><a id="l01823" name="l01823"></a><span class="lineno"> 1823</span><span class="comment">   *     - SYN or SYN_ACK</span></div>
<div class="line"><a id="l01824" name="l01824"></a><span class="lineno"> 1824</span><span class="comment">   *</span></div>
<div class="line"><a id="l01825" name="l01825"></a><span class="lineno"> 1825</span><span class="comment">   *   - [`m_snd_init_seq_num + 1`, `first_flying_seq_num - 1`] =</span></div>
<div class="line"><a id="l01826" name="l01826"></a><span class="lineno"> 1826</span><span class="comment">   *     - Largest possible range of sequence numbers such that each datum represented by this range</span></div>
<div class="line"><a id="l01827" name="l01827"></a><span class="lineno"> 1827</span><span class="comment">   *       has been sent and either:</span></div>
<div class="line"><a id="l01828" name="l01828"></a><span class="lineno"> 1828</span><span class="comment">   *       - Acknowledged (ACK received for it); or</span></div>
<div class="line"><a id="l01829" name="l01829"></a><span class="lineno"> 1829</span><span class="comment">   *       - Dropped (ACK not received; we consider it dropped due to some factor like timeout or</span></div>
<div class="line"><a id="l01830" name="l01830"></a><span class="lineno"> 1830</span><span class="comment">   *         duplicate ACKs);</span></div>
<div class="line"><a id="l01831" name="l01831"></a><span class="lineno"> 1831</span><span class="comment">   *</span></div>
<div class="line"><a id="l01832" name="l01832"></a><span class="lineno"> 1832</span><span class="comment">   *   - [`first_flying_seq_num`, `first_flying_seq_num + N - 1`] =</span></div>
<div class="line"><a id="l01833" name="l01833"></a><span class="lineno"> 1833</span><span class="comment">   *     - The first packet that has been sent that is neither Acknowledged nor Dropped.  `N` is length</span></div>
<div class="line"><a id="l01834" name="l01834"></a><span class="lineno"> 1834</span><span class="comment">   *       of that packet.  This is always the first packet, if any, to be considered Dropped in the</span></div>
<div class="line"><a id="l01835" name="l01835"></a><span class="lineno"> 1835</span><span class="comment">   *       future.  This packet is categorized In-flight.</span></div>
<div class="line"><a id="l01836" name="l01836"></a><span class="lineno"> 1836</span><span class="comment">   *</span></div>
<div class="line"><a id="l01837" name="l01837"></a><span class="lineno"> 1837</span><span class="comment">   *   - [`first_flying_seq_num + N`, `m_snd_next_seq_num - 1`] =</span></div>
<div class="line"><a id="l01838" name="l01838"></a><span class="lineno"> 1838</span><span class="comment">   *       - All remaining sent packets.  Each packet in this range is one of the following:</span></div>
<div class="line"><a id="l01839" name="l01839"></a><span class="lineno"> 1839</span><span class="comment">   *         - Acknowledged;</span></div>
<div class="line"><a id="l01840" name="l01840"></a><span class="lineno"> 1840</span><span class="comment">   *         - not Acknowledged and not Dropped = categorized In-flight.</span></div>
<div class="line"><a id="l01841" name="l01841"></a><span class="lineno"> 1841</span><span class="comment">   *</span></div>
<div class="line"><a id="l01842" name="l01842"></a><span class="lineno"> 1842</span><span class="comment">   *   - [#m_snd_next_seq_num, ...] =</span></div>
<div class="line"><a id="l01843" name="l01843"></a><span class="lineno"> 1843</span><span class="comment">   *     - Unsent packets, if any.</span></div>
<div class="line"><a id="l01844" name="l01844"></a><span class="lineno"> 1844</span><span class="comment">   *</span></div>
<div class="line"><a id="l01845" name="l01845"></a><span class="lineno"> 1845</span><span class="comment">   * #m_snd_flying_pkts_by_sent_when and #m_snd_flying_pkts_by_seq_num contain In-flight Sent_packet objects as values</span></div>
<div class="line"><a id="l01846" name="l01846"></a><span class="lineno"> 1846</span><span class="comment">   * (though the latter indirectly via iterator into the former) with each particular Sent_packet&#39;s first sequence</span></div>
<div class="line"><a id="l01847" name="l01847"></a><span class="lineno"> 1847</span><span class="comment">   * number as its key in either structure.  If there are no In-flight Sent_packet objects, then</span></div>
<div class="line"><a id="l01848" name="l01848"></a><span class="lineno"> 1848</span><span class="comment">   * `m_snd_flying_pkts_by_{sent_when|seq_num}.empty()` and hence `first_flying_seq_num` above does not</span></div>
<div class="line"><a id="l01849" name="l01849"></a><span class="lineno"> 1849</span><span class="comment">   * exist. Each of the [ranges] above can be null (empty).</span></div>
<div class="line"><a id="l01850" name="l01850"></a><span class="lineno"> 1850</span><span class="comment">   *</span></div>
<div class="line"><a id="l01851" name="l01851"></a><span class="lineno"> 1851</span><span class="comment">   * Each sent packet therefore is placed into #m_snd_flying_pkts_by_seq_num, at the back (if it&#39;s a new packet) or</span></div>
<div class="line"><a id="l01852" name="l01852"></a><span class="lineno"> 1852</span><span class="comment">   * possibly elsewhere (if it&#39;s retransmitted) -- while it is also placed into #m_snd_flying_pkts_by_sent_when but</span></div>
<div class="line"><a id="l01853" name="l01853"></a><span class="lineno"> 1853</span><span class="comment">   * always at the front (as, regardless of retransmission or anything else, it is the latest packet to be SENT).  When</span></div>
<div class="line"><a id="l01854" name="l01854"></a><span class="lineno"> 1854</span><span class="comment">   * packet is Acknowledged, it is removed from `m_snd_flying_pkts_by_*` -- could be from anywhere in</span></div>
<div class="line"><a id="l01855" name="l01855"></a><span class="lineno"> 1855</span><span class="comment">   * the ordering.  Similarly to Acknowledged packets, Dropped ones are also removed.</span></div>
<div class="line"><a id="l01856" name="l01856"></a><span class="lineno"> 1856</span><span class="comment">   *</span></div>
<div class="line"><a id="l01857" name="l01857"></a><span class="lineno"> 1857</span><span class="comment">   * Why do we need this map type in addition to `Linked_hash_map m_snd_flying_pkts_by_sent_when`?  Answer: Essentially,</span></div>
<div class="line"><a id="l01858" name="l01858"></a><span class="lineno"> 1858</span><span class="comment">   * when an acknowledgment comes in, we need to be able to determine where in the sequence number space this is.</span></div>
<div class="line"><a id="l01859" name="l01859"></a><span class="lineno"> 1859</span><span class="comment">   * If packets are ordered by send time -- not sequence number -- and the sequence number does not match</span></div>
<div class="line"><a id="l01860" name="l01860"></a><span class="lineno"> 1860</span><span class="comment">   * exactly one of the elements here (e.g., it erroneously straddles one, or it is a duplicate acknowledgement,</span></div>
<div class="line"><a id="l01861" name="l01861"></a><span class="lineno"> 1861</span><span class="comment">   * which means that element isn&#39;t in the map any longer), then a tree-sorted-by-key map is invaluable</span></div>
<div class="line"><a id="l01862" name="l01862"></a><span class="lineno"> 1862</span><span class="comment">   * (in particular: to get `upper_bound()`, and also to travel to the previous-by-sequence-number packet</span></div>
<div class="line"><a id="l01863" name="l01863"></a><span class="lineno"> 1863</span><span class="comment">   * from the latter).  So logarithmic-time upper-bound searches and iteration by sequence number are what we want and</span></div>
<div class="line"><a id="l01864" name="l01864"></a><span class="lineno"> 1864</span><span class="comment">   * get with this added ordering on top of #m_snd_flying_pkts_by_sent_when.</span></div>
<div class="line"><a id="l01865" name="l01865"></a><span class="lineno"> 1865</span><span class="comment">   *</span></div>
<div class="line"><a id="l01866" name="l01866"></a><span class="lineno"> 1866</span><span class="comment">   * ### Memory use ###</span></div>
<div class="line"><a id="l01867" name="l01867"></a><span class="lineno"> 1867</span><span class="comment">   * This structure&#39;s memory use is naturally bounded the same as #m_snd_flying_pkts_by_sent_when.</span></div>
<div class="line"><a id="l01868" name="l01868"></a><span class="lineno"> 1868</span><span class="comment">   *</span></div>
<div class="line"><a id="l01869" name="l01869"></a><span class="lineno"> 1869</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l01870" name="l01870"></a><span class="lineno"> 1870</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01871" name="l01871"></a><span class="lineno"> 1871</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01872" name="l01872"></a><span class="lineno"> 1872</span><span class="comment">   *</span></div>
<div class="line"><a id="l01873" name="l01873"></a><span class="lineno"> 1873</span><span class="comment">   * @see #m_snd_flying_pkts_by_sent_when. There&#39;s a &quot;see also&quot; comment there that contrasts these two</span></div>
<div class="line"><a id="l01874" name="l01874"></a><span class="lineno"> 1874</span><span class="comment">   *      important structures.</span></div>
<div class="line"><a id="l01875" name="l01875"></a><span class="lineno"> 1875</span><span class="comment">   */</span></div>
<div class="line"><a id="l01876" name="l01876"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a2db7d11ece920d4adcacd00eaa2253fd"> 1876</a></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a1958264af0c40f3c9c5769ddff4c9ade">Sent_pkt_by_seq_num_map</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a2db7d11ece920d4adcacd00eaa2253fd">m_snd_flying_pkts_by_seq_num</a>;</div>
<div class="line"><a id="l01877" name="l01877"></a><span class="lineno"> 1877</span><span class="comment"></span> </div>
<div class="line"><a id="l01878" name="l01878"></a><span class="lineno"> 1878</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01879" name="l01879"></a><span class="lineno"> 1879</span><span class="comment">   * The number of bytes contained in all In-flight packets, used at least for comparison against</span></div>
<div class="line"><a id="l01880" name="l01880"></a><span class="lineno"> 1880</span><span class="comment">   * the congestion window (CWND).  More formally, this is the sum of all Sent_packet::m_size values</span></div>
<div class="line"><a id="l01881" name="l01881"></a><span class="lineno"> 1881</span><span class="comment">   * in #m_snd_flying_pkts_by_sent_when.  We keep this, instead of computing it whenever needed, for</span></div>
<div class="line"><a id="l01882" name="l01882"></a><span class="lineno"> 1882</span><span class="comment">   * performance.  In various TCP and related RFCs this value (or something spiritually similar, if</span></div>
<div class="line"><a id="l01883" name="l01883"></a><span class="lineno"> 1883</span><span class="comment">   * only cumulative ACKs are used) is called &quot;pipe&quot; or &quot;FlightSize.&quot;</span></div>
<div class="line"><a id="l01884" name="l01884"></a><span class="lineno"> 1884</span><span class="comment">   *</span></div>
<div class="line"><a id="l01885" name="l01885"></a><span class="lineno"> 1885</span><span class="comment">   * Though in protocols like DCCP, where CWND is stored in packets, instead of bytes, &quot;pipe&quot; is</span></div>
<div class="line"><a id="l01886" name="l01886"></a><span class="lineno"> 1886</span><span class="comment">   * actually just `m_snd_flying_pkts_by_sent_when.size()`.  Not for us though.</span></div>
<div class="line"><a id="l01887" name="l01887"></a><span class="lineno"> 1887</span><span class="comment">   *</span></div>
<div class="line"><a id="l01888" name="l01888"></a><span class="lineno"> 1888</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01889" name="l01889"></a><span class="lineno"> 1889</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01890" name="l01890"></a><span class="lineno"> 1890</span><span class="comment">   *</span></div>
<div class="line"><a id="l01891" name="l01891"></a><span class="lineno"> 1891</span><span class="comment">   * @see #m_snd_flying_pkts_by_sent_when, which must always be updated to be accurate w/r/t</span></div>
<div class="line"><a id="l01892" name="l01892"></a><span class="lineno"> 1892</span><span class="comment">   *      #m_snd_flying_bytes.  Use Node::snd_flying_pkts_updated() whenever #m_snd_flying_pkts_by_sent_when</span></div>
<div class="line"><a id="l01893" name="l01893"></a><span class="lineno"> 1893</span><span class="comment">   *      is changed.</span></div>
<div class="line"><a id="l01894" name="l01894"></a><span class="lineno"> 1894</span><span class="comment">   */</span></div>
<div class="line"><a id="l01895" name="l01895"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ae870847f024fca7109c15557bb165480"> 1895</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ae870847f024fca7109c15557bb165480">m_snd_flying_bytes</a>;</div>
<div class="line"><a id="l01896" name="l01896"></a><span class="lineno"> 1896</span><span class="comment"></span> </div>
<div class="line"><a id="l01897" name="l01897"></a><span class="lineno"> 1897</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01898" name="l01898"></a><span class="lineno"> 1898</span><span class="comment">   * Helper data structure to store the packet IDs of packets that are marked Dropped during a single run</span></div>
<div class="line"><a id="l01899" name="l01899"></a><span class="lineno"> 1899</span><span class="comment">   * through accumulated ACKs; it is a data member instead of local variable for performance only.  The pattern is</span></div>
<div class="line"><a id="l01900" name="l01900"></a><span class="lineno"> 1900</span><span class="comment">   * to simply `clear()` it just before use, then load it up with stuff in that same round of ACK handling;</span></div>
<div class="line"><a id="l01901" name="l01901"></a><span class="lineno"> 1901</span><span class="comment">   * and the same thing each time we need to handle accumulated ACKs.  Normally one would just create one</span></div>
<div class="line"><a id="l01902" name="l01902"></a><span class="lineno"> 1902</span><span class="comment">   * of these locally within the code `{` block `}` each time instead.</span></div>
<div class="line"><a id="l01903" name="l01903"></a><span class="lineno"> 1903</span><span class="comment">   * Not doing so avoids unnecessary various internal-to-`vector` buffer</span></div>
<div class="line"><a id="l01904" name="l01904"></a><span class="lineno"> 1904</span><span class="comment">   * allocations.  Instead the internal buffer will grow as large as it needs to and not go down from there, so</span></div>
<div class="line"><a id="l01905" name="l01905"></a><span class="lineno"> 1905</span><span class="comment">   * that it can be reused in subsequent operations.  (Even `clear()` does not internally shrink the buffer.)</span></div>
<div class="line"><a id="l01906" name="l01906"></a><span class="lineno"> 1906</span><span class="comment">   * Of course some memory is held unnecessarily, but it&#39;s a small amount; on the other hand the performance</span></div>
<div class="line"><a id="l01907" name="l01907"></a><span class="lineno"> 1907</span><span class="comment">   * gain may be non-trivial due to the frequency of the ACK-handling code being invoked.</span></div>
<div class="line"><a id="l01908" name="l01908"></a><span class="lineno"> 1908</span><span class="comment">   *</span></div>
<div class="line"><a id="l01909" name="l01909"></a><span class="lineno"> 1909</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01910" name="l01910"></a><span class="lineno"> 1910</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01911" name="l01911"></a><span class="lineno"> 1911</span><span class="comment">   */</span></div>
<div class="line"><a id="l01912" name="l01912"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#aea98297d775f2085c21daf41c6582200"> 1912</a></span>  std::vector&lt;order_num_t&gt; <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#aea98297d775f2085c21daf41c6582200">m_snd_temp_pkts_marked_to_drop</a>;</div>
<div class="line"><a id="l01913" name="l01913"></a><span class="lineno"> 1913</span><span class="comment"></span> </div>
<div class="line"><a id="l01914" name="l01914"></a><span class="lineno"> 1914</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01915" name="l01915"></a><span class="lineno"> 1915</span><span class="comment">   * For the Sent_packet representing the next packet to be sent, this is the value to assign to</span></div>
<div class="line"><a id="l01916" name="l01916"></a><span class="lineno"> 1916</span><span class="comment">   * `m_sent_when.back().first`.  In other words it&#39;s an ever-increasing number that is sort of like</span></div>
<div class="line"><a id="l01917" name="l01917"></a><span class="lineno"> 1917</span><span class="comment">   * a sequence number but one per packet and represents time at which sent, not order in the byte stream.</span></div>
<div class="line"><a id="l01918" name="l01918"></a><span class="lineno"> 1918</span><span class="comment">   * In particular the same packet retransmitted will have the same sequence number the 2nd time but</span></div>
<div class="line"><a id="l01919" name="l01919"></a><span class="lineno"> 1919</span><span class="comment">   * an increased order number.  Starts at 0.</span></div>
<div class="line"><a id="l01920" name="l01920"></a><span class="lineno"> 1920</span><span class="comment">   *</span></div>
<div class="line"><a id="l01921" name="l01921"></a><span class="lineno"> 1921</span><span class="comment">   * This is only used for book-keeping locally and never transmitted over network.</span></div>
<div class="line"><a id="l01922" name="l01922"></a><span class="lineno"> 1922</span><span class="comment">   *</span></div>
<div class="line"><a id="l01923" name="l01923"></a><span class="lineno"> 1923</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01924" name="l01924"></a><span class="lineno"> 1924</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01925" name="l01925"></a><span class="lineno"> 1925</span><span class="comment">   */</span></div>
<div class="line"><a id="l01926" name="l01926"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a1ec79951579d595bb790be87189d6e6c"> 1926</a></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a797a524b73e2626fcfefe1be64f4d481">order_num_t</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a1ec79951579d595bb790be87189d6e6c">m_snd_last_order_num</a>;</div>
<div class="line"><a id="l01927" name="l01927"></a><span class="lineno"> 1927</span><span class="comment"></span> </div>
<div class="line"><a id="l01928" name="l01928"></a><span class="lineno"> 1928</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01929" name="l01929"></a><span class="lineno"> 1929</span><span class="comment">   * If retransmission is on, this is the retransmission queue.  It&#39;s the queue of packets determined to have</span></div>
<div class="line"><a id="l01930" name="l01930"></a><span class="lineno"> 1930</span><span class="comment">   * been dropped and thus to be retransmitted, when Congestion Window allows this.  Packet in Sent_packet::m_packet</span></div>
<div class="line"><a id="l01931" name="l01931"></a><span class="lineno"> 1931</span><span class="comment">   * field of element at top of the queue is to be retransmitted next; and the element itself is to be inserted into</span></div>
<div class="line"><a id="l01932" name="l01932"></a><span class="lineno"> 1932</span><span class="comment">   * #m_snd_flying_pkts_by_sent_when while popped from the present structure.  The packet&#39;s Data_packet::m_rexmit_id</span></div>
<div class="line"><a id="l01933" name="l01933"></a><span class="lineno"> 1933</span><span class="comment">   * should be incremented before sending; and the Sent_packet::m_sent_when `vector` should be appended with the</span></div>
<div class="line"><a id="l01934" name="l01934"></a><span class="lineno"> 1934</span><span class="comment">   * then-current time (for future RTT calculation).</span></div>
<div class="line"><a id="l01935" name="l01935"></a><span class="lineno"> 1935</span><span class="comment">   *</span></div>
<div class="line"><a id="l01936" name="l01936"></a><span class="lineno"> 1936</span><span class="comment">   * If retransmission is off, this is empty.</span></div>
<div class="line"><a id="l01937" name="l01937"></a><span class="lineno"> 1937</span><span class="comment">   *</span></div>
<div class="line"><a id="l01938" name="l01938"></a><span class="lineno"> 1938</span><span class="comment">   * Why use `list&lt;&gt;` and not `queue&lt;&gt;` or `deque&lt;&gt;`?  Answer: I&#39;d like to use `list::splice()`.</span></div>
<div class="line"><a id="l01939" name="l01939"></a><span class="lineno"> 1939</span><span class="comment">   *</span></div>
<div class="line"><a id="l01940" name="l01940"></a><span class="lineno"> 1940</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01941" name="l01941"></a><span class="lineno"> 1941</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01942" name="l01942"></a><span class="lineno"> 1942</span><span class="comment">   */</span></div>
<div class="line"><a id="l01943" name="l01943"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a845f21b754ef641b65b1fe44727fb429"> 1943</a></span>  std::list&lt;boost::shared_ptr&lt;Sent_packet&gt;&gt; <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a845f21b754ef641b65b1fe44727fb429">m_snd_rexmit_q</a>;</div>
<div class="line"><a id="l01944" name="l01944"></a><span class="lineno"> 1944</span><span class="comment"></span> </div>
<div class="line"><a id="l01945" name="l01945"></a><span class="lineno"> 1945</span><span class="comment">  /// Equals `m_snd_rexmit_q.size().`  Kept since `m_snd_rexmit_q.size()` may be @em O(n) depending on implementation.</span></div>
<div class="line"><a id="l01946" name="l01946"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a9f5063c85a2070822cf69a530f0af1f5"> 1946</a></span><span class="comment"></span>  <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a9f5063c85a2070822cf69a530f0af1f5">m_snd_rexmit_q_size</a>;</div>
<div class="line"><a id="l01947" name="l01947"></a><span class="lineno"> 1947</span><span class="comment"></span> </div>
<div class="line"><a id="l01948" name="l01948"></a><span class="lineno"> 1948</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01949" name="l01949"></a><span class="lineno"> 1949</span><span class="comment">   * The congestion control strategy in use for this connection on this side.  Node informs</span></div>
<div class="line"><a id="l01950" name="l01950"></a><span class="lineno"> 1950</span><span class="comment">   * this object of events, such as acknowedgments and loss events; conversely this object informs</span></div>
<div class="line"><a id="l01951" name="l01951"></a><span class="lineno"> 1951</span><span class="comment">   * (or can inform if asked) the Node whether or not DATA packets can be sent, by means of</span></div>
<div class="line"><a id="l01952" name="l01952"></a><span class="lineno"> 1952</span><span class="comment">   * providing the Node with the socket&#39;s current Congestion Window (CWND) computed based on the</span></div>
<div class="line"><a id="l01953" name="l01953"></a><span class="lineno"> 1953</span><span class="comment">   * particular Congestion_control_strategy implementation&#39;s algorithm (e.g., Reno or Westwood+).</span></div>
<div class="line"><a id="l01954" name="l01954"></a><span class="lineno"> 1954</span><span class="comment">   * Node then determines whether data can be sent by comparing #m_snd_flying_bytes (# of bytes we think</span></div>
<div class="line"><a id="l01955" name="l01955"></a><span class="lineno"> 1955</span><span class="comment">   * are currently In-flight) to CWND (# of bytes the strategy allows to be In-flight currently).</span></div>
<div class="line"><a id="l01956" name="l01956"></a><span class="lineno"> 1956</span><span class="comment">   *</span></div>
<div class="line"><a id="l01957" name="l01957"></a><span class="lineno"> 1957</span><span class="comment">   * ### Life cycle ###</span></div>
<div class="line"><a id="l01958" name="l01958"></a><span class="lineno"> 1958</span><span class="comment">   * #m_snd_cong_ctl must be initialized to an instance before user gains access to this</span></div>
<div class="line"><a id="l01959" name="l01959"></a><span class="lineno"> 1959</span><span class="comment">   * socket; the pointer must never change subsequently except back to null (permanently).  The</span></div>
<div class="line"><a id="l01960" name="l01960"></a><span class="lineno"> 1960</span><span class="comment">   * Peer_socket destructor, at the latest, will delete the underlying object, as #m_snd_cong_ctl</span></div>
<div class="line"><a id="l01961" name="l01961"></a><span class="lineno"> 1961</span><span class="comment">   * will be destructed.  (Note `unique_ptr` has no copy operator or</span></div>
<div class="line"><a id="l01962" name="l01962"></a><span class="lineno"> 1962</span><span class="comment">   * constructor.)  There is a 1-to-1 relationship between `*this` and #m_snd_cong_ctl.</span></div>
<div class="line"><a id="l01963" name="l01963"></a><span class="lineno"> 1963</span><span class="comment">   *</span></div>
<div class="line"><a id="l01964" name="l01964"></a><span class="lineno"> 1964</span><span class="comment">   * ### Visibility between Congestion_control_strategy and Peer_socket ###</span></div>
<div class="line"><a id="l01965" name="l01965"></a><span class="lineno"> 1965</span><span class="comment">   * #m_snd_cong_ctl gets read-only (`const`!) but otherwise complete</span></div>
<div class="line"><a id="l01966" name="l01966"></a><span class="lineno"> 1966</span><span class="comment">   * private access (via `friend`) to the contents of `*this` Peer_socket.  For example, it can</span></div>
<div class="line"><a id="l01967" name="l01967"></a><span class="lineno"> 1967</span><span class="comment">   * read `this-&gt;m_snd_smoothed_round_trip_time` (the SRTT) and use it</span></div>
<div class="line"><a id="l01968" name="l01968"></a><span class="lineno"> 1968</span><span class="comment">   * for computations if needed.  Node and Peer_socket get only strict public API access to</span></div>
<div class="line"><a id="l01969" name="l01969"></a><span class="lineno"> 1969</span><span class="comment">   * #m_snd_cong_ctl, which is a black box to it.</span></div>
<div class="line"><a id="l01970" name="l01970"></a><span class="lineno"> 1970</span><span class="comment">   *</span></div>
<div class="line"><a id="l01971" name="l01971"></a><span class="lineno"> 1971</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01972" name="l01972"></a><span class="lineno"> 1972</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01973" name="l01973"></a><span class="lineno"> 1973</span><span class="comment">   */</span></div>
<div class="line"><a id="l01974" name="l01974"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a35eb43f2b5d7dd46a941def4523f673c"> 1974</a></span>  boost::movelib::unique_ptr&lt;Congestion_control_strategy&gt; <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a35eb43f2b5d7dd46a941def4523f673c">m_snd_cong_ctl</a>;</div>
<div class="line"><a id="l01975" name="l01975"></a><span class="lineno"> 1975</span><span class="comment"></span> </div>
<div class="line"><a id="l01976" name="l01976"></a><span class="lineno"> 1976</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01977" name="l01977"></a><span class="lineno"> 1977</span><span class="comment">   * The receive window: the maximum number of bytes the other side has advertised it would be</span></div>
<div class="line"><a id="l01978" name="l01978"></a><span class="lineno"> 1978</span><span class="comment">   * willing to accept into its Receive buffer if they&#39;d arrived at the moment that advertisement</span></div>
<div class="line"><a id="l01979" name="l01979"></a><span class="lineno"> 1979</span><span class="comment">   * was generated by the other side.  This starts as 0 (undefined) and is originally set at SYN_ACK</span></div>
<div class="line"><a id="l01980" name="l01980"></a><span class="lineno"> 1980</span><span class="comment">   * or SYN_ACK_ACK receipt and then subsequently updated upon each ACK received.  Each such update</span></div>
<div class="line"><a id="l01981" name="l01981"></a><span class="lineno"> 1981</span><span class="comment">   * is called a &quot;rcv_wnd update&quot; or &quot;window update.&quot;</span></div>
<div class="line"><a id="l01982" name="l01982"></a><span class="lineno"> 1982</span><span class="comment">   *</span></div>
<div class="line"><a id="l01983" name="l01983"></a><span class="lineno"> 1983</span><span class="comment">   * #m_snd_cong_ctl provides congestion control; this value provides flow control.  The socket&#39;s</span></div>
<div class="line"><a id="l01984" name="l01984"></a><span class="lineno"> 1984</span><span class="comment">   * state machine must be extremely careful whenever either this value or</span></div>
<div class="line"><a id="l01985" name="l01985"></a><span class="lineno"> 1985</span><span class="comment">   * `m_snd_cong_ctl-&gt;congestion_window_bytes()` may increase, as when that occurs it should call</span></div>
<div class="line"><a id="l01986" name="l01986"></a><span class="lineno"> 1986</span><span class="comment">   * Node::send_worker() in order to possibly send data over the network.</span></div>
<div class="line"><a id="l01987" name="l01987"></a><span class="lineno"> 1987</span><span class="comment">   *</span></div>
<div class="line"><a id="l01988" name="l01988"></a><span class="lineno"> 1988</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l01989" name="l01989"></a><span class="lineno"> 1989</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l01990" name="l01990"></a><span class="lineno"> 1990</span><span class="comment">   */</span></div>
<div class="line"><a id="l01991" name="l01991"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a12611e0ac9e8b86b8304b855050a8c8c"> 1991</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a12611e0ac9e8b86b8304b855050a8c8c">m_snd_remote_rcv_wnd</a>;</div>
<div class="line"><a id="l01992" name="l01992"></a><span class="lineno"> 1992</span><span class="comment"></span> </div>
<div class="line"><a id="l01993" name="l01993"></a><span class="lineno"> 1993</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01994" name="l01994"></a><span class="lineno"> 1994</span><span class="comment">   * The outgoing available bandwidth estimator for this connection on this side.  Node informs</span></div>
<div class="line"><a id="l01995" name="l01995"></a><span class="lineno"> 1995</span><span class="comment">   * this object of events, namely as acknowedgments; conversely this object informs</span></div>
<div class="line"><a id="l01996" name="l01996"></a><span class="lineno"> 1996</span><span class="comment">   * (or can inform if asked) the Node what it thinks is the current available bandwidth for</span></div>
<div class="line"><a id="l01997" name="l01997"></a><span class="lineno"> 1997</span><span class="comment">   * user data in DATA packets.  This can be useful at least for some forms of congestion control</span></div>
<div class="line"><a id="l01998" name="l01998"></a><span class="lineno"> 1998</span><span class="comment">   * but possibly as information for the user, which is why it&#39;s an independent object and not</span></div>
<div class="line"><a id="l01999" name="l01999"></a><span class="lineno"> 1999</span><span class="comment">   * part of a specific congestion control strategy (I only mention this because the mechanics of such</span></div>
<div class="line"><a id="l02000" name="l02000"></a><span class="lineno"> 2000</span><span class="comment">   * a bandwidth estimator typically originate in service of a congestion control algorithm like Westwood+).</span></div>
<div class="line"><a id="l02001" name="l02001"></a><span class="lineno"> 2001</span><span class="comment">   *</span></div>
<div class="line"><a id="l02002" name="l02002"></a><span class="lineno"> 2002</span><span class="comment">   * ### Life cycle ###</span></div>
<div class="line"><a id="l02003" name="l02003"></a><span class="lineno"> 2003</span><span class="comment">   * It must be initialized to an instance before user gains access to this</span></div>
<div class="line"><a id="l02004" name="l02004"></a><span class="lineno"> 2004</span><span class="comment">   * socket; the pointer must never change subsequently except back to null (permanently).  The</span></div>
<div class="line"><a id="l02005" name="l02005"></a><span class="lineno"> 2005</span><span class="comment">   * Peer_socket destructor, at the latest, will delete the underlying object, as #m_snd_bandwidth_estimator</span></div>
<div class="line"><a id="l02006" name="l02006"></a><span class="lineno"> 2006</span><span class="comment">   * is destroyed along with `*this`.  The only reason it&#39;s a pointer is that it takes a Const_ptr in the constructor,</span></div>
<div class="line"><a id="l02007" name="l02007"></a><span class="lineno"> 2007</span><span class="comment">   * and that&#39;s not available during Peer_socket construction yet.  (Note `unique_ptr` has no copy operator or</span></div>
<div class="line"><a id="l02008" name="l02008"></a><span class="lineno"> 2008</span><span class="comment">   * constructor.)  There is a 1-to-1 relationship between `*this` and #m_snd_bandwidth_estimator.</span></div>
<div class="line"><a id="l02009" name="l02009"></a><span class="lineno"> 2009</span><span class="comment">   *</span></div>
<div class="line"><a id="l02010" name="l02010"></a><span class="lineno"> 2010</span><span class="comment">   * ### Visibility between Send_bandwidth_estimator and Peer_socket ###</span></div>
<div class="line"><a id="l02011" name="l02011"></a><span class="lineno"> 2011</span><span class="comment">   * The former gets read-only (`const`!) but otherwise complete private access (via `friend`) to the contents of</span></div>
<div class="line"><a id="l02012" name="l02012"></a><span class="lineno"> 2012</span><span class="comment">   * `*this` Peer_socket.  For example, it can read #m_snd_smoothed_round_trip_time (the SRTT) and use it</span></div>
<div class="line"><a id="l02013" name="l02013"></a><span class="lineno"> 2013</span><span class="comment">   * for computations if needed.  Node and Peer_socket get only strict public API access to</span></div>
<div class="line"><a id="l02014" name="l02014"></a><span class="lineno"> 2014</span><span class="comment">   * #m_snd_bandwidth_estimator, which is a black box to it.</span></div>
<div class="line"><a id="l02015" name="l02015"></a><span class="lineno"> 2015</span><span class="comment">   *</span></div>
<div class="line"><a id="l02016" name="l02016"></a><span class="lineno"> 2016</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l02017" name="l02017"></a><span class="lineno"> 2017</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l02018" name="l02018"></a><span class="lineno"> 2018</span><span class="comment">   */</span></div>
<div class="line"><a id="l02019" name="l02019"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a2dd08c5fed4d179e4fde3a632c084751"> 2019</a></span>  boost::movelib::unique_ptr&lt;Send_bandwidth_estimator&gt; <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a2dd08c5fed4d179e4fde3a632c084751">m_snd_bandwidth_estimator</a>;</div>
<div class="line"><a id="l02020" name="l02020"></a><span class="lineno"> 2020</span><span class="comment"></span> </div>
<div class="line"><a id="l02021" name="l02021"></a><span class="lineno"> 2021</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02022" name="l02022"></a><span class="lineno"> 2022</span><span class="comment">   * Estimated current round trip time of packets, computed as a smooth value over the</span></div>
<div class="line"><a id="l02023" name="l02023"></a><span class="lineno"> 2023</span><span class="comment">   * past individual RTT measurements.  This is updated each time we make an RTT measurement (i.e.,</span></div>
<div class="line"><a id="l02024" name="l02024"></a><span class="lineno"> 2024</span><span class="comment">   * receive a valid, non-duplicate acknowledgment of a packet we&#39;d sent).  The algorithm to compute</span></div>
<div class="line"><a id="l02025" name="l02025"></a><span class="lineno"> 2025</span><span class="comment">   * it is taken from RFC 6298.  The value is 0 (not a legal value otherwise) until the first RTT</span></div>
<div class="line"><a id="l02026" name="l02026"></a><span class="lineno"> 2026</span><span class="comment">   * measurement is made.</span></div>
<div class="line"><a id="l02027" name="l02027"></a><span class="lineno"> 2027</span><span class="comment">   *</span></div>
<div class="line"><a id="l02028" name="l02028"></a><span class="lineno"> 2028</span><span class="comment">   * We use #Fine_duration (the high fine-grainedness and large bit width corresponding to #Fine_clock) to</span></div>
<div class="line"><a id="l02029" name="l02029"></a><span class="lineno"> 2029</span><span class="comment">   * store this, and the algorithm we use to compute it avoids losing digits via unnecessary</span></div>
<div class="line"><a id="l02030" name="l02030"></a><span class="lineno"> 2030</span><span class="comment">   * conversions between units (e.g., nanoseconds -&gt; milliseconds).</span></div>
<div class="line"><a id="l02031" name="l02031"></a><span class="lineno"> 2031</span><span class="comment">   *</span></div>
<div class="line"><a id="l02032" name="l02032"></a><span class="lineno"> 2032</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l02033" name="l02033"></a><span class="lineno"> 2033</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l02034" name="l02034"></a><span class="lineno"> 2034</span><span class="comment">   */</span></div>
<div class="line"><a id="l02035" name="l02035"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ad08b53052e7eedfa7a925258f5ef1cba"> 2035</a></span>  <a class="code hl_typedef" href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">Fine_duration</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ad08b53052e7eedfa7a925258f5ef1cba">m_snd_smoothed_round_trip_time</a>;</div>
<div class="line"><a id="l02036" name="l02036"></a><span class="lineno"> 2036</span><span class="comment"></span> </div>
<div class="line"><a id="l02037" name="l02037"></a><span class="lineno"> 2037</span><span class="comment">  /// RTTVAR used for #m_snd_smoothed_round_trip_time calculation.  @see #m_snd_smoothed_round_trip_time.</span></div>
<div class="line"><a id="l02038" name="l02038"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a27ce5b19ab4abcf61aa07153c46b2be3"> 2038</a></span><span class="comment"></span>  <a class="code hl_typedef" href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">Fine_duration</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a27ce5b19ab4abcf61aa07153c46b2be3">m_round_trip_time_variance</a>;</div>
<div class="line"><a id="l02039" name="l02039"></a><span class="lineno"> 2039</span><span class="comment"></span> </div>
<div class="line"><a id="l02040" name="l02040"></a><span class="lineno"> 2040</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02041" name="l02041"></a><span class="lineno"> 2041</span><span class="comment">   * The Drop Timer engine, which controls how In-flight (#m_snd_flying_pkts_by_sent_when) packets are</span></div>
<div class="line"><a id="l02042" name="l02042"></a><span class="lineno"> 2042</span><span class="comment">   * considered Dropped due to being unacknowledged for too long.  Used while #m_int_state is</span></div>
<div class="line"><a id="l02043" name="l02043"></a><span class="lineno"> 2043</span><span class="comment">   * Int_state::S_ESTABLISHED.</span></div>
<div class="line"><a id="l02044" name="l02044"></a><span class="lineno"> 2044</span><span class="comment">   *</span></div>
<div class="line"><a id="l02045" name="l02045"></a><span class="lineno"> 2045</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l02046" name="l02046"></a><span class="lineno"> 2046</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l02047" name="l02047"></a><span class="lineno"> 2047</span><span class="comment">   */</span></div>
<div class="line"><a id="l02048" name="l02048"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a037459e6f1345cedf45e490d544c8567"> 2048</a></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#ae804be57cf09b9bf76eafa8ffff73de6">Drop_timer_ptr</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a037459e6f1345cedf45e490d544c8567">m_snd_drop_timer</a>;</div>
<div class="line"><a id="l02049" name="l02049"></a><span class="lineno"> 2049</span><span class="comment"></span> </div>
<div class="line"><a id="l02050" name="l02050"></a><span class="lineno"> 2050</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02051" name="l02051"></a><span class="lineno"> 2051</span><span class="comment">   * The Drop Timeout: Time period between the next time #m_snd_drop_timer schedules a Drop Timer and that timer</span></div>
<div class="line"><a id="l02052" name="l02052"></a><span class="lineno"> 2052</span><span class="comment">   * expiring.  This is updated each time #m_snd_smoothed_round_trip_time is updated, and the Drop_timer</span></div>
<div class="line"><a id="l02053" name="l02053"></a><span class="lineno"> 2053</span><span class="comment">   * itself may change it under certain circumstances.</span></div>
<div class="line"><a id="l02054" name="l02054"></a><span class="lineno"> 2054</span><span class="comment">   *</span></div>
<div class="line"><a id="l02055" name="l02055"></a><span class="lineno"> 2055</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l02056" name="l02056"></a><span class="lineno"> 2056</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l02057" name="l02057"></a><span class="lineno"> 2057</span><span class="comment">   */</span></div>
<div class="line"><a id="l02058" name="l02058"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a2d8aded3761028967fd3abb464e64936"> 2058</a></span>  <a class="code hl_typedef" href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">Fine_duration</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a2d8aded3761028967fd3abb464e64936">m_snd_drop_timeout</a>;</div>
<div class="line"><a id="l02059" name="l02059"></a><span class="lineno"> 2059</span><span class="comment"></span> </div>
<div class="line"><a id="l02060" name="l02060"></a><span class="lineno"> 2060</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02061" name="l02061"></a><span class="lineno"> 2061</span><span class="comment">   * The state of outgoing packet pacing for this socket; segregated into a simple `struct` to keep</span></div>
<div class="line"><a id="l02062" name="l02062"></a><span class="lineno"> 2062</span><span class="comment">   * Peer_socket shorter and easier to understand.  Packet pacing tries to combat the burstiness of</span></div>
<div class="line"><a id="l02063" name="l02063"></a><span class="lineno"> 2063</span><span class="comment">   * outgoing low-level packet stream.</span></div>
<div class="line"><a id="l02064" name="l02064"></a><span class="lineno"> 2064</span><span class="comment">   *</span></div>
<div class="line"><a id="l02065" name="l02065"></a><span class="lineno"> 2065</span><span class="comment">   * @see `struct Send_pacing_data` doc header for much detail.</span></div>
<div class="line"><a id="l02066" name="l02066"></a><span class="lineno"> 2066</span><span class="comment">   */</span></div>
<div class="line"><a id="l02067" name="l02067"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a55b44104a2c305b9679434ba623a7357"> 2067</a></span>  <a class="code hl_struct" href="structflow_1_1net__flow_1_1Send__pacing__data.html">Send_pacing_data</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a55b44104a2c305b9679434ba623a7357">m_snd_pacing_data</a>;</div>
<div class="line"><a id="l02068" name="l02068"></a><span class="lineno"> 2068</span><span class="comment"></span> </div>
<div class="line"><a id="l02069" name="l02069"></a><span class="lineno"> 2069</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02070" name="l02070"></a><span class="lineno"> 2070</span><span class="comment">   * The last time that Node has detected a packet loss event and so informed #m_snd_cong_ctl by calling</span></div>
<div class="line"><a id="l02071" name="l02071"></a><span class="lineno"> 2071</span><span class="comment">   * the appropriate method of class Congestion_control_strategy.  Roughly speaking, this is used to</span></div>
<div class="line"><a id="l02072" name="l02072"></a><span class="lineno"> 2072</span><span class="comment">   * determine whether the detection of a given dropped packet is part of the same loss event as the</span></div>
<div class="line"><a id="l02073" name="l02073"></a><span class="lineno"> 2073</span><span class="comment">   * previous one; if so then #m_snd_cong_ctl is not informed again (presumably to avoid dropping CWND</span></div>
<div class="line"><a id="l02074" name="l02074"></a><span class="lineno"> 2074</span><span class="comment">   * too fast); if not it is informed of the new loss event.  Even more roughly speaking, if the new</span></div>
<div class="line"><a id="l02075" name="l02075"></a><span class="lineno"> 2075</span><span class="comment">   * event is within a certain time frame of #m_snd_last_loss_event_when, then they&#39;re considered in the</span></div>
<div class="line"><a id="l02076" name="l02076"></a><span class="lineno"> 2076</span><span class="comment">   * same loss event.  You can find detailed discussion in a giant comment in</span></div>
<div class="line"><a id="l02077" name="l02077"></a><span class="lineno"> 2077</span><span class="comment">   * Node::handle_accumulated_acks().</span></div>
<div class="line"><a id="l02078" name="l02078"></a><span class="lineno"> 2078</span><span class="comment">   *</span></div>
<div class="line"><a id="l02079" name="l02079"></a><span class="lineno"> 2079</span><span class="comment">   * Before any loss events, this is set to its default value (zero time since epoch).</span></div>
<div class="line"><a id="l02080" name="l02080"></a><span class="lineno"> 2080</span><span class="comment">   *</span></div>
<div class="line"><a id="l02081" name="l02081"></a><span class="lineno"> 2081</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l02082" name="l02082"></a><span class="lineno"> 2082</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l02083" name="l02083"></a><span class="lineno"> 2083</span><span class="comment">   */</span></div>
<div class="line"><a id="l02084" name="l02084"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#aa9f77167af54cfe2921fab5fd143eff4"> 2084</a></span>  <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#aa9f77167af54cfe2921fab5fd143eff4">m_snd_last_loss_event_when</a>;</div>
<div class="line"><a id="l02085" name="l02085"></a><span class="lineno"> 2085</span><span class="comment"></span> </div>
<div class="line"><a id="l02086" name="l02086"></a><span class="lineno"> 2086</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02087" name="l02087"></a><span class="lineno"> 2087</span><span class="comment">   * Time at which the last Data_packet low-level packet for this connection was sent.  We</span></div>
<div class="line"><a id="l02088" name="l02088"></a><span class="lineno"> 2088</span><span class="comment">   * use this when determining whether the connection is in Idle Timeout (i.e., has sent no traffic</span></div>
<div class="line"><a id="l02089" name="l02089"></a><span class="lineno"> 2089</span><span class="comment">   * for a while, which means there has been no data to send).  It&#39;s used for congestion control.</span></div>
<div class="line"><a id="l02090" name="l02090"></a><span class="lineno"> 2090</span><span class="comment">   *</span></div>
<div class="line"><a id="l02091" name="l02091"></a><span class="lineno"> 2091</span><span class="comment">   * Before any packets are sent, this is set to its default value (zero time since epoch).</span></div>
<div class="line"><a id="l02092" name="l02092"></a><span class="lineno"> 2092</span><span class="comment">   *</span></div>
<div class="line"><a id="l02093" name="l02093"></a><span class="lineno"> 2093</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l02094" name="l02094"></a><span class="lineno"> 2094</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l02095" name="l02095"></a><span class="lineno"> 2095</span><span class="comment">   *</span></div>
<div class="line"><a id="l02096" name="l02096"></a><span class="lineno"> 2096</span><span class="comment">   * ### Pacing ###</span></div>
<div class="line"><a id="l02097" name="l02097"></a><span class="lineno"> 2097</span><span class="comment">   * See Send_packet_pacing #m_snd_pacing_data.  See pacing-relevant note on Sent_packet::m_sent_when</span></div>
<div class="line"><a id="l02098" name="l02098"></a><span class="lineno"> 2098</span><span class="comment">   * which applies equally to this data member.</span></div>
<div class="line"><a id="l02099" name="l02099"></a><span class="lineno"> 2099</span><span class="comment">   */</span></div>
<div class="line"><a id="l02100" name="l02100"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#af392484f79ffcead4f74ca351672d8d4"> 2100</a></span>  <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#af392484f79ffcead4f74ca351672d8d4">m_snd_last_data_sent_when</a>;</div>
<div class="line"><a id="l02101" name="l02101"></a><span class="lineno"> 2101</span><span class="comment"></span> </div>
<div class="line"><a id="l02102" name="l02102"></a><span class="lineno"> 2102</span><span class="comment">  /// Stats regarding outgoing traffic (and resulting incoming ACKs) for this connection so far.</span></div>
<div class="line"><a id="l02103" name="l02103"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ab4aff3e65ef9551b6c5ab890173b741e"> 2103</a></span><span class="comment"></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Peer__socket__send__stats__accumulator.html">Peer_socket_send_stats_accumulator</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ab4aff3e65ef9551b6c5ab890173b741e">m_snd_stats</a>;</div>
<div class="line"><a id="l02104" name="l02104"></a><span class="lineno"> 2104</span><span class="comment"></span> </div>
<div class="line"><a id="l02105" name="l02105"></a><span class="lineno"> 2105</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02106" name="l02106"></a><span class="lineno"> 2106</span><span class="comment">   * Random security token used during SYN_ACK-SYN_ACK_ACK.  For a given connection handshake, the</span></div>
<div class="line"><a id="l02107" name="l02107"></a><span class="lineno"> 2107</span><span class="comment">   * SYN_ACK_ACK receiver ensures that #m_security_token it received is equal to the original one it</span></div>
<div class="line"><a id="l02108" name="l02108"></a><span class="lineno"> 2108</span><span class="comment">   * had sent in SYN_ACK.  This first gains meaning upong sending SYN_ACK and it does not change afterwards.</span></div>
<div class="line"><a id="l02109" name="l02109"></a><span class="lineno"> 2109</span><span class="comment">   * It is not used unless `!m_active_connect`.  See #m_active_connect.</span></div>
<div class="line"><a id="l02110" name="l02110"></a><span class="lineno"> 2110</span><span class="comment">   *</span></div>
<div class="line"><a id="l02111" name="l02111"></a><span class="lineno"> 2111</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l02112" name="l02112"></a><span class="lineno"> 2112</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l02113" name="l02113"></a><span class="lineno"> 2113</span><span class="comment">   */</span></div>
<div class="line"><a id="l02114" name="l02114"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a33a90b123612cc2e6a119cfa95ba4f6d"> 2114</a></span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a59db68ed0c77a9f6e1a7aeeb3df2a6b9">security_token_t</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a33a90b123612cc2e6a119cfa95ba4f6d">m_security_token</a>;</div>
<div class="line"><a id="l02115" name="l02115"></a><span class="lineno"> 2115</span><span class="comment"></span> </div>
<div class="line"><a id="l02116" name="l02116"></a><span class="lineno"> 2116</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02117" name="l02117"></a><span class="lineno"> 2117</span><span class="comment">   * Connection attempt scheduled task; fires if an individual connection request packet is not answered with a reply</span></div>
<div class="line"><a id="l02118" name="l02118"></a><span class="lineno"> 2118</span><span class="comment">   * packet in time.  It is readied when *any* SYN or SYN_ACK packet is sent, and fired if that packet has gone</span></div>
<div class="line"><a id="l02119" name="l02119"></a><span class="lineno"> 2119</span><span class="comment">   * unacknowledged with a SYN_ACK or SYN_ACK_ACK (respectively), long enough to be retransmitted.</span></div>
<div class="line"><a id="l02120" name="l02120"></a><span class="lineno"> 2120</span><span class="comment">   *</span></div>
<div class="line"><a id="l02121" name="l02121"></a><span class="lineno"> 2121</span><span class="comment">   * Connection establishment is aborted if it fires too many times, but #m_connection_timeout_scheduled_task is how</span></div>
<div class="line"><a id="l02122" name="l02122"></a><span class="lineno"> 2122</span><span class="comment">   * &quot;too many times&quot; is determined.</span></div>
<div class="line"><a id="l02123" name="l02123"></a><span class="lineno"> 2123</span><span class="comment">   *</span></div>
<div class="line"><a id="l02124" name="l02124"></a><span class="lineno"> 2124</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l02125" name="l02125"></a><span class="lineno"> 2125</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l02126" name="l02126"></a><span class="lineno"> 2126</span><span class="comment">   *</span></div>
<div class="line"><a id="l02127" name="l02127"></a><span class="lineno"> 2127</span><span class="comment">   * @see #m_connection_timeout_scheduled_task which keeps track of the entire process timing out, as opposed to the</span></div>
<div class="line"><a id="l02128" name="l02128"></a><span class="lineno"> 2128</span><span class="comment">   *      individual attempts.</span></div>
<div class="line"><a id="l02129" name="l02129"></a><span class="lineno"> 2129</span><span class="comment">   */</span></div>
<div class="line"><a id="l02130" name="l02130"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a85b3d271527dbaa04b1d9f751631fd71"> 2130</a></span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">util::Scheduled_task_handle</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a85b3d271527dbaa04b1d9f751631fd71">m_init_rexmit_scheduled_task</a>;</div>
<div class="line"><a id="l02131" name="l02131"></a><span class="lineno"> 2131</span><span class="comment"></span> </div>
<div class="line"><a id="l02132" name="l02132"></a><span class="lineno"> 2132</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02133" name="l02133"></a><span class="lineno"> 2133</span><span class="comment">   * If currently using #m_init_rexmit_scheduled_task, this is the number of times the timer has already fired</span></div>
<div class="line"><a id="l02134" name="l02134"></a><span class="lineno"> 2134</span><span class="comment">   * in this session.  So when the timer is readied the first time it&#39;s zero; if it fires and is</span></div>
<div class="line"><a id="l02135" name="l02135"></a><span class="lineno"> 2135</span><span class="comment">   * thus readied again it&#39;s one; again =&gt; two; etc., until timer is canceled or connection is</span></div>
<div class="line"><a id="l02136" name="l02136"></a><span class="lineno"> 2136</span><span class="comment">   * aborted due to too many retries.</span></div>
<div class="line"><a id="l02137" name="l02137"></a><span class="lineno"> 2137</span><span class="comment">   *</span></div>
<div class="line"><a id="l02138" name="l02138"></a><span class="lineno"> 2138</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l02139" name="l02139"></a><span class="lineno"> 2139</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l02140" name="l02140"></a><span class="lineno"> 2140</span><span class="comment">   */</span></div>
<div class="line"><a id="l02141" name="l02141"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a0d1eecb59c62912b5630359df774dc62"> 2141</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a0d1eecb59c62912b5630359df774dc62">m_init_rexmit_count</a>;</div>
<div class="line"><a id="l02142" name="l02142"></a><span class="lineno"> 2142</span><span class="comment"></span> </div>
<div class="line"><a id="l02143" name="l02143"></a><span class="lineno"> 2143</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02144" name="l02144"></a><span class="lineno"> 2144</span><span class="comment">   * Connection timeout scheduled task; fires if the entire initial connection process does not complete within a</span></div>
<div class="line"><a id="l02145" name="l02145"></a><span class="lineno"> 2145</span><span class="comment">   * certain amount of time.  It is started when the SYN or SYN_ACK is sent the very first time (NOT counting</span></div>
<div class="line"><a id="l02146" name="l02146"></a><span class="lineno"> 2146</span><span class="comment">   * resends), canceled when SYN_ACK or SYN_ACK_ACK (respectively) is received in response to ANY SYN or</span></div>
<div class="line"><a id="l02147" name="l02147"></a><span class="lineno"> 2147</span><span class="comment">   * SYN_ACK (respevtively), and fired if the the latter does not occur in time.</span></div>
<div class="line"><a id="l02148" name="l02148"></a><span class="lineno"> 2148</span><span class="comment">   *</span></div>
<div class="line"><a id="l02149" name="l02149"></a><span class="lineno"> 2149</span><span class="comment">   * This gains meaning only in thread W.  This should NOT be accessed outside of thread W and is</span></div>
<div class="line"><a id="l02150" name="l02150"></a><span class="lineno"> 2150</span><span class="comment">   * not protected by a mutex.</span></div>
<div class="line"><a id="l02151" name="l02151"></a><span class="lineno"> 2151</span><span class="comment">   *</span></div>
<div class="line"><a id="l02152" name="l02152"></a><span class="lineno"> 2152</span><span class="comment">   * @see #m_init_rexmit_scheduled_task which keeps track of *individual* attempts timing out, as opposed to the</span></div>
<div class="line"><a id="l02153" name="l02153"></a><span class="lineno"> 2153</span><span class="comment">   *      entire process.</span></div>
<div class="line"><a id="l02154" name="l02154"></a><span class="lineno"> 2154</span><span class="comment">   */</span></div>
<div class="line"><a id="l02155" name="l02155"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ad772e56de286567c4b7a681907b5f285"> 2155</a></span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">util::Scheduled_task_handle</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ad772e56de286567c4b7a681907b5f285">m_connection_timeout_scheduled_task</a>;</div>
<div class="line"><a id="l02156" name="l02156"></a><span class="lineno"> 2156</span><span class="comment"></span> </div>
<div class="line"><a id="l02157" name="l02157"></a><span class="lineno"> 2157</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02158" name="l02158"></a><span class="lineno"> 2158</span><span class="comment">   * This is the final set of stats collected at the time the socket was moved to S_CLOSED #m_state.</span></div>
<div class="line"><a id="l02159" name="l02159"></a><span class="lineno"> 2159</span><span class="comment">   * If it has not yet moved to that state, this is not applicable (but equals Peer_socket_info()).</span></div>
<div class="line"><a id="l02160" name="l02160"></a><span class="lineno"> 2160</span><span class="comment">   * It&#39;s used by info() to get at the final set of stats, before the source info is purged by the</span></div>
<div class="line"><a id="l02161" name="l02161"></a><span class="lineno"> 2161</span><span class="comment">   * resource cleanup in sock_free_memory().</span></div>
<div class="line"><a id="l02162" name="l02162"></a><span class="lineno"> 2162</span><span class="comment">   */</span></div>
<div class="line"><a id="l02163" name="l02163"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ac4c942e1bb6c4dc4b24251f294a2f92d"> 2163</a></span>  <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__info.html">Peer_socket_info</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ac4c942e1bb6c4dc4b24251f294a2f92d">m_info_on_close</a>;</div>
<div class="line"><a id="l02164" name="l02164"></a><span class="lineno"> 2164</span>}; <span class="comment">// class Peer_socket</span></div>
<div class="line"><a id="l02165" name="l02165"></a><span class="lineno"> 2165</span> </div>
<div class="line"><a id="l02166" name="l02166"></a><span class="lineno"> 2166</span><span class="comment"></span> </div>
<div class="line"><a id="l02167" name="l02167"></a><span class="lineno"> 2167</span><span class="comment">/**</span></div>
<div class="line"><a id="l02168" name="l02168"></a><span class="lineno"> 2168</span><span class="comment"> * @private</span></div>
<div class="line"><a id="l02169" name="l02169"></a><span class="lineno"> 2169</span><span class="comment"> *</span></div>
<div class="line"><a id="l02170" name="l02170"></a><span class="lineno"> 2170</span><span class="comment"> * Metadata (and data, if retransmission is on) for a packet that has been sent one (if</span></div>
<div class="line"><a id="l02171" name="l02171"></a><span class="lineno"> 2171</span><span class="comment"> * retransmission is off) or possibly more (if on) times.  This is purely a data store, not a</span></div>
<div class="line"><a id="l02172" name="l02172"></a><span class="lineno"> 2172</span><span class="comment"> * class.  It is not copyable, and moving them around by smart Sent_packet::Ptr is encouraged.</span></div>
<div class="line"><a id="l02173" name="l02173"></a><span class="lineno"> 2173</span><span class="comment"> */</span></div>
<div class="line"><a id="l02174" name="l02174"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html"> 2174</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html">Peer_socket::Sent_packet</a> :</div>
<div class="line"><a id="l02175" name="l02175"></a><span class="lineno"> 2175</span>  <span class="comment">// Endow us with shared_ptr&lt;&gt;s ::Ptr and ::Const_ptr (syntactic sugar).</span></div>
<div class="line"><a id="l02176" name="l02176"></a><span class="lineno"> 2176</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1util_1_1Shared__ptr__alias__holder.html">util::Shared_ptr_alias_holder</a>&lt;boost::shared_ptr&lt;Peer_socket::Sent_packet&gt;&gt;,</div>
<div class="line"><a id="l02177" name="l02177"></a><span class="lineno"> 2177</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l02178" name="l02178"></a><span class="lineno"> 2178</span>{</div>
<div class="line"><a id="l02179" name="l02179"></a><span class="lineno"> 2179</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l02180" name="l02180"></a><span class="lineno"> 2180</span> </div>
<div class="line"><a id="l02181" name="l02181"></a><span class="lineno"> 2181</span>  <span class="keyword">struct </span><a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html">Sent_when</a>;</div>
<div class="line"><a id="l02182" name="l02182"></a><span class="lineno"> 2182</span><span class="comment"></span> </div>
<div class="line"><a id="l02183" name="l02183"></a><span class="lineno"> 2183</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02184" name="l02184"></a><span class="lineno"> 2184</span><span class="comment">   * Type used for #m_acks_after_me.  Use a small type to save memory; this is easily large enough,</span></div>
<div class="line"><a id="l02185" name="l02185"></a><span class="lineno"> 2185</span><span class="comment">   * given that that we drop a packet after #m_acks_after_me exceeds a very small value (&lt; 10), and</span></div>
<div class="line"><a id="l02186" name="l02186"></a><span class="lineno"> 2186</span><span class="comment">   * a given ACK can *conceivably* hold a few thousand individual acknowledgments (most likely many</span></div>
<div class="line"><a id="l02187" name="l02187"></a><span class="lineno"> 2187</span><span class="comment">   * fewer).  In fact `uint8_t` is probably enough, but it seemed easier to not worry about</span></div>
<div class="line"><a id="l02188" name="l02188"></a><span class="lineno"> 2188</span><span class="comment">   * overflows when doing arithmetic with these.</span></div>
<div class="line"><a id="l02189" name="l02189"></a><span class="lineno"> 2189</span><span class="comment">   */</span></div>
<div class="line"><a id="l02190" name="l02190"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a7913f73b4e2f164ca51ebb505b63c1f2"> 2190</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a7913f73b4e2f164ca51ebb505b63c1f2">ack_count_t</a> = uint16_t;</div>
<div class="line"><a id="l02191" name="l02191"></a><span class="lineno"> 2191</span> </div>
<div class="line"><a id="l02192" name="l02192"></a><span class="lineno"> 2192</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l02193" name="l02193"></a><span class="lineno"> 2193</span><span class="comment"></span> </div>
<div class="line"><a id="l02194" name="l02194"></a><span class="lineno"> 2194</span><span class="comment">  /// Number of bytes in the Data_packet::m_data field of the sent packet.</span></div>
<div class="line"><a id="l02195" name="l02195"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a5b5762a1effba90f631c06ad76f9774b"> 2195</a></span><span class="comment"></span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a5b5762a1effba90f631c06ad76f9774b">m_size</a>;</div>
<div class="line"><a id="l02196" name="l02196"></a><span class="lineno"> 2196</span><span class="comment"></span> </div>
<div class="line"><a id="l02197" name="l02197"></a><span class="lineno"> 2197</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02198" name="l02198"></a><span class="lineno"> 2198</span><span class="comment">   * Time stamps, order numbers, and other info at the times when the different attempts (including</span></div>
<div class="line"><a id="l02199" name="l02199"></a><span class="lineno"> 2199</span><span class="comment">   * original sending and retransmissions) to send the packet were given to the UDP net-stack. These are</span></div>
<div class="line"><a id="l02200" name="l02200"></a><span class="lineno"> 2200</span><span class="comment">   * arranged in the order they were sent (0 = original transmission, 1 = first retransmission, 2 = second</span></div>
<div class="line"><a id="l02201" name="l02201"></a><span class="lineno"> 2201</span><span class="comment">   * retransmission, ...).  If retransmission is off, this only ever has 1 element (set via</span></div>
<div class="line"><a id="l02202" name="l02202"></a><span class="lineno"> 2202</span><span class="comment">   * constructor).</span></div>
<div class="line"><a id="l02203" name="l02203"></a><span class="lineno"> 2203</span><span class="comment">   *</span></div>
<div class="line"><a id="l02204" name="l02204"></a><span class="lineno"> 2204</span><span class="comment">   * Along with each time stamp, we also store an order number.  It is much like a sequence</span></div>
<div class="line"><a id="l02205" name="l02205"></a><span class="lineno"> 2205</span><span class="comment">   * number, except (a) we never send it anywhere (internal bookkeeping only), (b) it specifies</span></div>
<div class="line"><a id="l02206" name="l02206"></a><span class="lineno"> 2206</span><span class="comment">   * the order in which the packets were sent off.  Why use that and not a `m_sent_time` timestamp?  Because</span></div>
<div class="line"><a id="l02207" name="l02207"></a><span class="lineno"> 2207</span><span class="comment">   * `m_sent_time` can, in theory, have ties (i.e., it&#39;s kind of possible for 2 packets to be sent</span></div>
<div class="line"><a id="l02208" name="l02208"></a><span class="lineno"> 2208</span><span class="comment">   * within the same high-resolution clock tick).  This gives us a solid way to order packets by send time</span></div>
<div class="line"><a id="l02209" name="l02209"></a><span class="lineno"> 2209</span><span class="comment">   * in certain key algorithms.</span></div>
<div class="line"><a id="l02210" name="l02210"></a><span class="lineno"> 2210</span><span class="comment">   *</span></div>
<div class="line"><a id="l02211" name="l02211"></a><span class="lineno"> 2211</span><span class="comment">   * Note: for reasons explained in the pacing module this should be the time stamp when we</span></div>
<div class="line"><a id="l02212" name="l02212"></a><span class="lineno"> 2212</span><span class="comment">   * actually send it off to boost.asio UDP net-stack, not when we queue it into the pacing module (which can be</span></div>
<div class="line"><a id="l02213" name="l02213"></a><span class="lineno"> 2213</span><span class="comment">   * quite a bit earlier, if pacing is enabled).  Subtlety: Note that &quot;time stamp when we actually send it off</span></div>
<div class="line"><a id="l02214" name="l02214"></a><span class="lineno"> 2214</span><span class="comment">   * to boost.asio UDP net-stack&quot; IS the same as &quot;time stamp when boost.asio UDP net-stack actually performs the</span></div>
<div class="line"><a id="l02215" name="l02215"></a><span class="lineno"> 2215</span><span class="comment">   * `sendto()` call&quot; in practice -- a good thing for accurate RTT measurements.</span></div>
<div class="line"><a id="l02216" name="l02216"></a><span class="lineno"> 2216</span><span class="comment">   */</span></div>
<div class="line"><a id="l02217" name="l02217"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a3acccd2fcd0f4a0c5f7f0c2d6ad31c2e"> 2217</a></span>  std::vector&lt;Sent_when&gt; <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a3acccd2fcd0f4a0c5f7f0c2d6ad31c2e">m_sent_when</a>;</div>
<div class="line"><a id="l02218" name="l02218"></a><span class="lineno"> 2218</span><span class="comment"></span> </div>
<div class="line"><a id="l02219" name="l02219"></a><span class="lineno"> 2219</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02220" name="l02220"></a><span class="lineno"> 2220</span><span class="comment">   * The number of times any packet with `m_sent_when.back().m_order_num &gt; this-&gt;m_sent_when.back().m_order_num`</span></div>
<div class="line"><a id="l02221" name="l02221"></a><span class="lineno"> 2221</span><span class="comment">   * has been acknowledged.  Reworded slightly: start at 0; *IF* a packet, other than this one, is In-flight and then</span></div>
<div class="line"><a id="l02222" name="l02222"></a><span class="lineno"> 2222</span><span class="comment">   * acknowledged, and that packet was sent out (or, equivalently, scheduled to be sent out -- packets do not</span></div>
<div class="line"><a id="l02223" name="l02223"></a><span class="lineno"> 2223</span><span class="comment">   * change order once marked for sending -- a/k/a became In-flight) chronologically AFTER same happened to</span></div>
<div class="line"><a id="l02224" name="l02224"></a><span class="lineno"> 2224</span><span class="comment">   * `*this` packet *THEN* add 1.  After adding up all such acks, the resulting value = this member.</span></div>
<div class="line"><a id="l02225" name="l02225"></a><span class="lineno"> 2225</span><span class="comment">   *</span></div>
<div class="line"><a id="l02226" name="l02226"></a><span class="lineno"> 2226</span><span class="comment">   * This is used to determine when `*this` packet should be considered Dropped,</span></div>
<div class="line"><a id="l02227" name="l02227"></a><span class="lineno"> 2227</span><span class="comment">   * as in TCP&#39;s Fast Retransmit heuristic (but better, since time-when-sent -- not sequence number, which has</span></div>
<div class="line"><a id="l02228" name="l02228"></a><span class="lineno"> 2228</span><span class="comment">   * retransmission ambiguities -- is used to order packets).</span></div>
<div class="line"><a id="l02229" name="l02229"></a><span class="lineno"> 2229</span><span class="comment">   *</span></div>
<div class="line"><a id="l02230" name="l02230"></a><span class="lineno"> 2230</span><span class="comment">   * Note, again, that &quot;after&quot; has little to do with *sequence* number but rather with send time, as ordered via</span></div>
<div class="line"><a id="l02231" name="l02231"></a><span class="lineno"> 2231</span><span class="comment">   * the *order* number.  E.g., due to retransmission, `*this` may have sequence number greater than another</span></div>
<div class="line"><a id="l02232" name="l02232"></a><span class="lineno"> 2232</span><span class="comment">   * packet yet have the lesser order number.  (This dichotomy is mentioned a lot, everywhere, and if I&#39;m overdoing</span></div>
<div class="line"><a id="l02233" name="l02233"></a><span class="lineno"> 2233</span><span class="comment">   * it, it&#39;s only because sometimes TCP cumulative-ack habits die hard, so I have to keep reminding myself.)</span></div>
<div class="line"><a id="l02234" name="l02234"></a><span class="lineno"> 2234</span><span class="comment">   * (If retransmission is disabled, however, then sequence number order = order number order.)</span></div>
<div class="line"><a id="l02235" name="l02235"></a><span class="lineno"> 2235</span><span class="comment">   */</span></div>
<div class="line"><a id="l02236" name="l02236"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#affeb974bc03966744adfcda0366a50aa"> 2236</a></span>  <a class="code hl_typedef" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a7913f73b4e2f164ca51ebb505b63c1f2">ack_count_t</a> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#affeb974bc03966744adfcda0366a50aa">m_acks_after_me</a>;</div>
<div class="line"><a id="l02237" name="l02237"></a><span class="lineno"> 2237</span><span class="comment"></span> </div>
<div class="line"><a id="l02238" name="l02238"></a><span class="lineno"> 2238</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02239" name="l02239"></a><span class="lineno"> 2239</span><span class="comment">   * If retransmission is on, this is the DATA packet itself that was sent; otherwise null.  It is</span></div>
<div class="line"><a id="l02240" name="l02240"></a><span class="lineno"> 2240</span><span class="comment">   * stored in case we need to retransmit it.  If we don&#39;t (it is acknowledged), the entire</span></div>
<div class="line"><a id="l02241" name="l02241"></a><span class="lineno"> 2241</span><span class="comment">   * Sent_packet is erased and goes away, so #m_packet&#39;s ref-count decreases to zero, and it</span></div>
<div class="line"><a id="l02242" name="l02242"></a><span class="lineno"> 2242</span><span class="comment">   * disappears.  If we do, all we need to do to retransmit it is increment its Data_packet::m_rexmit_id and</span></div>
<div class="line"><a id="l02243" name="l02243"></a><span class="lineno"> 2243</span><span class="comment">   * place it into the retransmission queue for sending, when CWND space is available.</span></div>
<div class="line"><a id="l02244" name="l02244"></a><span class="lineno"> 2244</span><span class="comment">   *</span></div>
<div class="line"><a id="l02245" name="l02245"></a><span class="lineno"> 2245</span><span class="comment">   * Why store the entire packet and not just its Data_packet::m_data?  There&#39;s a small bit of memory overhead, but</span></div>
<div class="line"><a id="l02246" name="l02246"></a><span class="lineno"> 2246</span><span class="comment">   * we get Data_packet::m_rexmit_id for free and don&#39;t have to spend time re-creating the packet to retransmit.</span></div>
<div class="line"><a id="l02247" name="l02247"></a><span class="lineno"> 2247</span><span class="comment">   * So it&#39;s just convenient.</span></div>
<div class="line"><a id="l02248" name="l02248"></a><span class="lineno"> 2248</span><span class="comment">   *</span></div>
<div class="line"><a id="l02249" name="l02249"></a><span class="lineno"> 2249</span><span class="comment">   * If retransmission is off, there is no need to store this, as it will not be re-sent.</span></div>
<div class="line"><a id="l02250" name="l02250"></a><span class="lineno"> 2250</span><span class="comment">   */</span></div>
<div class="line"><a id="l02251" name="l02251"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a704afa0007b8354ad78acad64d029ecf"> 2251</a></span>  <span class="keyword">const</span> boost::shared_ptr&lt;Data_packet&gt; <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a704afa0007b8354ad78acad64d029ecf">m_packet</a>;</div>
<div class="line"><a id="l02252" name="l02252"></a><span class="lineno"> 2252</span> </div>
<div class="line"><a id="l02253" name="l02253"></a><span class="lineno"> 2253</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l02254" name="l02254"></a><span class="lineno"> 2254</span><span class="comment"></span> </div>
<div class="line"><a id="l02255" name="l02255"></a><span class="lineno"> 2255</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02256" name="l02256"></a><span class="lineno"> 2256</span><span class="comment">   * Constructs object with the given values and #m_acks_after_me at zero.  If rexmit-on option enabled, the</span></div>
<div class="line"><a id="l02257" name="l02257"></a><span class="lineno"> 2257</span><span class="comment">   * packet is stored in #m_packet; otherwise #m_packet is initialized to null.  Regardless, #m_size</span></div>
<div class="line"><a id="l02258" name="l02258"></a><span class="lineno"> 2258</span><span class="comment">   * is set to `packet.m_data.size()`.</span></div>
<div class="line"><a id="l02259" name="l02259"></a><span class="lineno"> 2259</span><span class="comment">   *</span></div>
<div class="line"><a id="l02260" name="l02260"></a><span class="lineno"> 2260</span><span class="comment">   * @param rexmit_on</span></div>
<div class="line"><a id="l02261" name="l02261"></a><span class="lineno"> 2261</span><span class="comment">   *        True if and only if `sock-&gt;rexmit_on()` for the containing socket.</span></div>
<div class="line"><a id="l02262" name="l02262"></a><span class="lineno"> 2262</span><span class="comment">   * @param packet</span></div>
<div class="line"><a id="l02263" name="l02263"></a><span class="lineno"> 2263</span><span class="comment">   *        The packet that will be sent.  Used for #m_size and, if `sock-&gt;rexmit_on()`, saved in #m_packet.</span></div>
<div class="line"><a id="l02264" name="l02264"></a><span class="lineno"> 2264</span><span class="comment">   * @param sent_when</span></div>
<div class="line"><a id="l02265" name="l02265"></a><span class="lineno"> 2265</span><span class="comment">   *        #m_sent_when is set to contain one element equalling this argument.</span></div>
<div class="line"><a id="l02266" name="l02266"></a><span class="lineno"> 2266</span><span class="comment">   */</span></div>
<div class="line"><a id="l02267" name="l02267"></a><span class="lineno"> 2267</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a28eb52fe9520497d02f6c0cd51a5fa9b">Sent_packet</a>(<span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a89d852e3722532d75006b024714a5cef">rexmit_on</a>, boost::shared_ptr&lt;Data_packet&gt; packet, <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html">Sent_when</a>&amp; sent_when);</div>
<div class="line"><a id="l02268" name="l02268"></a><span class="lineno"> 2268</span>}; <span class="comment">// struct Peer_socket::Sent_packet</span></div>
<div class="line"><a id="l02269" name="l02269"></a><span class="lineno"> 2269</span><span class="comment"></span> </div>
<div class="line"><a id="l02270" name="l02270"></a><span class="lineno"> 2270</span><span class="comment">/**</span></div>
<div class="line"><a id="l02271" name="l02271"></a><span class="lineno"> 2271</span><span class="comment"> * @private</span></div>
<div class="line"><a id="l02272" name="l02272"></a><span class="lineno"> 2272</span><span class="comment"> *</span></div>
<div class="line"><a id="l02273" name="l02273"></a><span class="lineno"> 2273</span><span class="comment"> * Data store to keep timing related info when a packet is sent out.  Construct via direct member initialization.</span></div>
<div class="line"><a id="l02274" name="l02274"></a><span class="lineno"> 2274</span><span class="comment"> * It is copy-constructible (for initially copying into containers and such) but not assignable to discourage</span></div>
<div class="line"><a id="l02275" name="l02275"></a><span class="lineno"> 2275</span><span class="comment"> * unneeded copying (though it is not a heavy structure).  Update: A later version of clang does not like</span></div>
<div class="line"><a id="l02276" name="l02276"></a><span class="lineno"> 2276</span><span class="comment"> * this technique and warns about it; to avoid any such trouble just forget the non-assignability stuff;</span></div>
<div class="line"><a id="l02277" name="l02277"></a><span class="lineno"> 2277</span><span class="comment"> * it&#39;s internal code; we should be fine.</span></div>
<div class="line"><a id="l02278" name="l02278"></a><span class="lineno"> 2278</span><span class="comment"> */</span></div>
<div class="line"><a id="l02279" name="l02279"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html"> 2279</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html">Peer_socket::Sent_packet::Sent_when</a></div>
<div class="line"><a id="l02280" name="l02280"></a><span class="lineno"> 2280</span>{</div>
<div class="line"><a id="l02281" name="l02281"></a><span class="lineno"> 2281</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l02282" name="l02282"></a><span class="lineno"> 2282</span><span class="comment"></span> </div>
<div class="line"><a id="l02283" name="l02283"></a><span class="lineno"> 2283</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02284" name="l02284"></a><span class="lineno"> 2284</span><span class="comment">   * Order number of the packet.  This can be used to compare two packets sent out; the one with the</span></div>
<div class="line"><a id="l02285" name="l02285"></a><span class="lineno"> 2285</span><span class="comment">   * higher order number was sent out later.  See Peer_socket::m_snd_last_order_num.  The per-socket next-value</span></div>
<div class="line"><a id="l02286" name="l02286"></a><span class="lineno"> 2286</span><span class="comment">   * for this is incremented each time another packet is sent out.</span></div>
<div class="line"><a id="l02287" name="l02287"></a><span class="lineno"> 2287</span><span class="comment">   *</span></div>
<div class="line"><a id="l02288" name="l02288"></a><span class="lineno"> 2288</span><span class="comment">   * @see Peer_socket::Sent_packet::m_sent_when for more discussion.</span></div>
<div class="line"><a id="l02289" name="l02289"></a><span class="lineno"> 2289</span><span class="comment">   *</span></div>
<div class="line"><a id="l02290" name="l02290"></a><span class="lineno"> 2290</span><span class="comment">   * @internal</span></div>
<div class="line"><a id="l02291" name="l02291"></a><span class="lineno"> 2291</span><span class="comment">   * @todo Can we make Sent_when::m_order_num and some of its peers const?</span></div>
<div class="line"><a id="l02292" name="l02292"></a><span class="lineno"> 2292</span><span class="comment">   */</span></div>
<div class="line"><a id="l02293" name="l02293"></a><span class="lineno"> 2293</span>  <span class="comment">// That @internal should not be necessary to hide the @todo in public generated docs -- Doxygen bug?</span></div>
<div class="line"><a id="l02294" name="l02294"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html#a5265c3824ad25d1de4f888fa811dd4e6"> 2294</a></span>  <span class="keyword">const</span> <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a797a524b73e2626fcfefe1be64f4d481">order_num_t</a> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html#a5265c3824ad25d1de4f888fa811dd4e6">m_order_num</a>;</div>
<div class="line"><a id="l02295" name="l02295"></a><span class="lineno"> 2295</span><span class="comment"></span> </div>
<div class="line"><a id="l02296" name="l02296"></a><span class="lineno"> 2296</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02297" name="l02297"></a><span class="lineno"> 2297</span><span class="comment">   * The timestamp when the packet is sent out.  This may be &quot;corrected&quot; when actually sent *after* pacing delay</span></div>
<div class="line"><a id="l02298" name="l02298"></a><span class="lineno"> 2298</span><span class="comment">   * (hence not `const`).</span></div>
<div class="line"><a id="l02299" name="l02299"></a><span class="lineno"> 2299</span><span class="comment">   *</span></div>
<div class="line"><a id="l02300" name="l02300"></a><span class="lineno"> 2300</span><span class="comment">   * @see Fine_clock.  Recall that, due to latter&#39;s properties, `Fine_clock::now()` results monotonically increase</span></div>
<div class="line"><a id="l02301" name="l02301"></a><span class="lineno"> 2301</span><span class="comment">   *      over time -- a property on which we rely on, particularly since this data member is only assigned</span></div>
<div class="line"><a id="l02302" name="l02302"></a><span class="lineno"> 2302</span><span class="comment">   *      `Fine_clock::now()` at various times.</span></div>
<div class="line"><a id="l02303" name="l02303"></a><span class="lineno"> 2303</span><span class="comment">   *</span></div>
<div class="line"><a id="l02304" name="l02304"></a><span class="lineno"> 2304</span><span class="comment">   * @see Peer_socket::Sent_packet::m_sent_when for more discussion.</span></div>
<div class="line"><a id="l02305" name="l02305"></a><span class="lineno"> 2305</span><span class="comment">   */</span></div>
<div class="line"><a id="l02306" name="l02306"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html#ad513e58f4eb611c3a91d96df26f53f2c"> 2306</a></span>  <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html#ad513e58f4eb611c3a91d96df26f53f2c">m_sent_time</a>;</div>
<div class="line"><a id="l02307" name="l02307"></a><span class="lineno"> 2307</span><span class="comment"></span> </div>
<div class="line"><a id="l02308" name="l02308"></a><span class="lineno"> 2308</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02309" name="l02309"></a><span class="lineno"> 2309</span><span class="comment">   * The congestion window size (in bytes) that is used when the packet is sent out.</span></div>
<div class="line"><a id="l02310" name="l02310"></a><span class="lineno"> 2310</span><span class="comment">   * We store this to pass to the congestion control module when this packet is acked in the future.</span></div>
<div class="line"><a id="l02311" name="l02311"></a><span class="lineno"> 2311</span><span class="comment">   * Some congestion control algorithms compute CWND based on an earlier CWND value.</span></div>
<div class="line"><a id="l02312" name="l02312"></a><span class="lineno"> 2312</span><span class="comment">   * Not `const` for similar reason as #m_sent_time.</span></div>
<div class="line"><a id="l02313" name="l02313"></a><span class="lineno"> 2313</span><span class="comment">   *</span></div>
<div class="line"><a id="l02314" name="l02314"></a><span class="lineno"> 2314</span><span class="comment">   * @internal</span></div>
<div class="line"><a id="l02315" name="l02315"></a><span class="lineno"> 2315</span><span class="comment">   * @todo Why is #m_sent_cwnd_bytes in Sent_when `struct` and not directly in `Sent_packet`?  Or maybe it should</span></div>
<div class="line"><a id="l02316" name="l02316"></a><span class="lineno"> 2316</span><span class="comment">   * stay here, but Sent_when should be renamed `Send_attempt` (or `Send_try` for brevity)?  Yeah, I think that&#39;s</span></div>
<div class="line"><a id="l02317" name="l02317"></a><span class="lineno"> 2317</span><span class="comment">   * it.  Then Sent_packet::m_sent_when -- a container of Sent_when objects -- would become `m_send_tries`, a</span></div>
<div class="line"><a id="l02318" name="l02318"></a><span class="lineno"> 2318</span><span class="comment">   * container of `Send_try` objects.  That makes more sense (sentce?!) than the status quo which involves the</span></div>
<div class="line"><a id="l02319" name="l02319"></a><span class="lineno"> 2319</span><span class="comment">   * singular-means-plural strangeness.</span></div>
<div class="line"><a id="l02320" name="l02320"></a><span class="lineno"> 2320</span><span class="comment">   *</span></div>
<div class="line"><a id="l02321" name="l02321"></a><span class="lineno"> 2321</span><span class="comment">   * @todo Can we make #m_sent_cwnd_bytes and some of its peers `const`?</span></div>
<div class="line"><a id="l02322" name="l02322"></a><span class="lineno"> 2322</span><span class="comment">   */</span></div>
<div class="line"><a id="l02323" name="l02323"></a><span class="lineno"> 2323</span>  <span class="comment">// That @internal should not be necessary to hide the @todo in public generated docs -- Doxygen bug?</span></div>
<div class="line"><a id="l02324" name="l02324"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html#abc5bf2e627dad5d2dcfb0324853b37f7"> 2324</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html#abc5bf2e627dad5d2dcfb0324853b37f7">m_sent_cwnd_bytes</a>;</div>
<div class="line"><a id="l02325" name="l02325"></a><span class="lineno"> 2325</span>}; <span class="comment">// struct Peer_socket::Sent_packet::Sent_when</span></div>
<div class="line"><a id="l02326" name="l02326"></a><span class="lineno"> 2326</span><span class="comment"></span> </div>
<div class="line"><a id="l02327" name="l02327"></a><span class="lineno"> 2327</span><span class="comment">/**</span></div>
<div class="line"><a id="l02328" name="l02328"></a><span class="lineno"> 2328</span><span class="comment"> * @private</span></div>
<div class="line"><a id="l02329" name="l02329"></a><span class="lineno"> 2329</span><span class="comment"> *</span></div>
<div class="line"><a id="l02330" name="l02330"></a><span class="lineno"> 2330</span><span class="comment"> * Metadata (and data, if retransmission is on) for a packet that has been received (and, if</span></div>
<div class="line"><a id="l02331" name="l02331"></a><span class="lineno"> 2331</span><span class="comment"> * retransmission is off, copied to Receive buffer).  This is purely a data store, not a class.</span></div>
<div class="line"><a id="l02332" name="l02332"></a><span class="lineno"> 2332</span><span class="comment"> * It is not copyable, and moving them around by smart Received_packet::Ptr is encouraged.</span></div>
<div class="line"><a id="l02333" name="l02333"></a><span class="lineno"> 2333</span><span class="comment"> */</span></div>
<div class="line"><a id="l02334" name="l02334"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html"> 2334</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html">Peer_socket::Received_packet</a> :</div>
<div class="line"><a id="l02335" name="l02335"></a><span class="lineno"> 2335</span>  <span class="comment">// Endow us with shared_ptr&lt;&gt;s ::Ptr and ::Const_ptr (syntactic sugar).</span></div>
<div class="line"><a id="l02336" name="l02336"></a><span class="lineno"> 2336</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1util_1_1Shared__ptr__alias__holder.html">util::Shared_ptr_alias_holder</a>&lt;boost::shared_ptr&lt;Peer_socket::Received_packet&gt;&gt;,</div>
<div class="line"><a id="l02337" name="l02337"></a><span class="lineno"> 2337</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l02338" name="l02338"></a><span class="lineno"> 2338</span>{</div>
<div class="line"><a id="l02339" name="l02339"></a><span class="lineno"> 2339</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l02340" name="l02340"></a><span class="lineno"> 2340</span><span class="comment"></span> </div>
<div class="line"><a id="l02341" name="l02341"></a><span class="lineno"> 2341</span><span class="comment">  /// Number of bytes in the Data_packet::m_data field of that packet.</span></div>
<div class="line"><a id="l02342" name="l02342"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html#a7d0760b1dead081bdcf775fbca7f708b"> 2342</a></span><span class="comment"></span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html#a7d0760b1dead081bdcf775fbca7f708b">m_size</a>;</div>
<div class="line"><a id="l02343" name="l02343"></a><span class="lineno"> 2343</span><span class="comment"></span> </div>
<div class="line"><a id="l02344" name="l02344"></a><span class="lineno"> 2344</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02345" name="l02345"></a><span class="lineno"> 2345</span><span class="comment">   * Byte sequence equal to that of Data_packet::m_data of the packet.  Kept `empty()` if retransmission is off,</span></div>
<div class="line"><a id="l02346" name="l02346"></a><span class="lineno"> 2346</span><span class="comment">   * since in that mode any received packet&#39;s `m_data` is immediately moved to Receive buffer.  With</span></div>
<div class="line"><a id="l02347" name="l02347"></a><span class="lineno"> 2347</span><span class="comment">   * retransmission on, it is stored until all gaps before the packet are filled (a/k/a</span></div>
<div class="line"><a id="l02348" name="l02348"></a><span class="lineno"> 2348</span><span class="comment">   * reassembly).</span></div>
<div class="line"><a id="l02349" name="l02349"></a><span class="lineno"> 2349</span><span class="comment">   */</span></div>
<div class="line"><a id="l02350" name="l02350"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html#ac3e88e37e53d2572f89c599e520e3e2a"> 2350</a></span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#af09888b3a8feaff209b6625e493bc338">util::Blob</a> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html#ac3e88e37e53d2572f89c599e520e3e2a">m_data</a>;</div>
<div class="line"><a id="l02351" name="l02351"></a><span class="lineno"> 2351</span> </div>
<div class="line"><a id="l02352" name="l02352"></a><span class="lineno"> 2352</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l02353" name="l02353"></a><span class="lineno"> 2353</span><span class="comment"></span> </div>
<div class="line"><a id="l02354" name="l02354"></a><span class="lineno"> 2354</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02355" name="l02355"></a><span class="lineno"> 2355</span><span class="comment">   * Constructs object by storing size of data and, if so instructed, the data themselves.</span></div>
<div class="line"><a id="l02356" name="l02356"></a><span class="lineno"> 2356</span><span class="comment">   *</span></div>
<div class="line"><a id="l02357" name="l02357"></a><span class="lineno"> 2357</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l02358" name="l02358"></a><span class="lineno"> 2358</span><span class="comment">   *        The Logger implementation to use subsequently.</span></div>
<div class="line"><a id="l02359" name="l02359"></a><span class="lineno"> 2359</span><span class="comment">   * @param size</span></div>
<div class="line"><a id="l02360" name="l02360"></a><span class="lineno"> 2360</span><span class="comment">   *        #m_size.</span></div>
<div class="line"><a id="l02361" name="l02361"></a><span class="lineno"> 2361</span><span class="comment">   * @param src_data</span></div>
<div class="line"><a id="l02362" name="l02362"></a><span class="lineno"> 2362</span><span class="comment">   *        Pointer to the packet data to be moved into #m_data; or null if we shouldn&#39;t store it.</span></div>
<div class="line"><a id="l02363" name="l02363"></a><span class="lineno"> 2363</span><span class="comment">   *        This should be null if and only if retransmission is off.  If not null, for</span></div>
<div class="line"><a id="l02364" name="l02364"></a><span class="lineno"> 2364</span><span class="comment">   *        performance, `*src_data` is CLEARED by this constructor (its data moved, in constant</span></div>
<div class="line"><a id="l02365" name="l02365"></a><span class="lineno"> 2365</span><span class="comment">   *        time, into #m_data).  In that case, `src_data.size() == size` must be true at entrance to</span></div>
<div class="line"><a id="l02366" name="l02366"></a><span class="lineno"> 2366</span><span class="comment">   *        constructor, or behavior is undefined.</span></div>
<div class="line"><a id="l02367" name="l02367"></a><span class="lineno"> 2367</span><span class="comment">   */</span></div>
<div class="line"><a id="l02368" name="l02368"></a><span class="lineno"> 2368</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html#a9f0809d5dd7272e31f4111ee2be97330">Received_packet</a>(<a class="code hl_class" href="classflow_1_1log_1_1Logger.html">log::Logger</a>* logger_ptr, <span class="keywordtype">size_t</span> size, <a class="code hl_typedef" href="namespaceflow_1_1util.html#af09888b3a8feaff209b6625e493bc338">util::Blob</a>* src_data);</div>
<div class="line"><a id="l02369" name="l02369"></a><span class="lineno"> 2369</span>};</div>
<div class="line"><a id="l02370" name="l02370"></a><span class="lineno"> 2370</span><span class="comment"></span> </div>
<div class="line"><a id="l02371" name="l02371"></a><span class="lineno"> 2371</span><span class="comment">/**</span></div>
<div class="line"><a id="l02372" name="l02372"></a><span class="lineno"> 2372</span><span class="comment"> * @private</span></div>
<div class="line"><a id="l02373" name="l02373"></a><span class="lineno"> 2373</span><span class="comment"> *</span></div>
<div class="line"><a id="l02374" name="l02374"></a><span class="lineno"> 2374</span><span class="comment"> * Metadata describing the data sent in the acknowledgment of an individual received packet.  (A</span></div>
<div class="line"><a id="l02375" name="l02375"></a><span class="lineno"> 2375</span><span class="comment"> * low-level ACK packet may include several sets of such data.)  This is purely a data store, not</span></div>
<div class="line"><a id="l02376" name="l02376"></a><span class="lineno"> 2376</span><span class="comment"> * a class.  It is not copyable, and moving them around by smart Individual_ack::Ptr is encouraged.</span></div>
<div class="line"><a id="l02377" name="l02377"></a><span class="lineno"> 2377</span><span class="comment"> * Construct this by direct member initialization.</span></div>
<div class="line"><a id="l02378" name="l02378"></a><span class="lineno"> 2378</span><span class="comment"> */</span></div>
<div class="line"><a id="l02379" name="l02379"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html"> 2379</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html">Peer_socket::Individual_ack</a></div>
<div class="line"><a id="l02380" name="l02380"></a><span class="lineno"> 2380</span>  <span class="comment">// Cannot use boost::noncopyable or Shared_ptr_alias_holder, because that turns off direct initialization.</span></div>
<div class="line"><a id="l02381" name="l02381"></a><span class="lineno"> 2381</span>{</div>
<div class="line"><a id="l02382" name="l02382"></a><span class="lineno"> 2382</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l02383" name="l02383"></a><span class="lineno"> 2383</span><span class="comment"></span> </div>
<div class="line"><a id="l02384" name="l02384"></a><span class="lineno"> 2384</span><span class="comment">  /// Short-hand for ref-counted pointer to mutable objects of this class.</span></div>
<div class="line"><a id="l02385" name="l02385"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#ad32d17739f7965eeeedfbeae5bfbc1a3"> 2385</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#ad32d17739f7965eeeedfbeae5bfbc1a3">Ptr</a> = boost::shared_ptr&lt;Individual_ack&gt;;</div>
<div class="line"><a id="l02386" name="l02386"></a><span class="lineno"> 2386</span><span class="comment"></span> </div>
<div class="line"><a id="l02387" name="l02387"></a><span class="lineno"> 2387</span><span class="comment">  /// Short-hand for ref-counted pointer to immutable objects of this class.</span></div>
<div class="line"><a id="l02388" name="l02388"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a209d79e058d103c84fc10be84d492a8b"> 2388</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a209d79e058d103c84fc10be84d492a8b">Const_ptr</a> = boost::shared_ptr&lt;const Individual_ack&gt;;</div>
<div class="line"><a id="l02389" name="l02389"></a><span class="lineno"> 2389</span> </div>
<div class="line"><a id="l02390" name="l02390"></a><span class="lineno"> 2390</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l02391" name="l02391"></a><span class="lineno"> 2391</span><span class="comment"></span> </div>
<div class="line"><a id="l02392" name="l02392"></a><span class="lineno"> 2392</span><span class="comment">  /// Sequence number of first datum in packet.</span></div>
<div class="line"><a id="l02393" name="l02393"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a8a237605b83d8a0d1b175395a83ad768"> 2393</a></span><span class="comment"></span>  <span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1net__flow_1_1Sequence__number.html">Sequence_number</a> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a8a237605b83d8a0d1b175395a83ad768">m_seq_num</a>;</div>
<div class="line"><a id="l02394" name="l02394"></a><span class="lineno"> 2394</span><span class="comment"></span> </div>
<div class="line"><a id="l02395" name="l02395"></a><span class="lineno"> 2395</span><span class="comment">  /**</span></div>
<div class="line"><a id="l02396" name="l02396"></a><span class="lineno"> 2396</span><span class="comment">   * Retransmit counter of the packet (as reported by sender).  Identifies which attempt we are</span></div>
<div class="line"><a id="l02397" name="l02397"></a><span class="lineno"> 2397</span><span class="comment">   * acknowledging (0 = initial, 1 = first retransmit, 2 = second retransmit, ...).  Always 0</span></div>
<div class="line"><a id="l02398" name="l02398"></a><span class="lineno"> 2398</span><span class="comment">   * unless retransmission is on.</span></div>
<div class="line"><a id="l02399" name="l02399"></a><span class="lineno"> 2399</span><span class="comment">   */</span></div>
<div class="line"><a id="l02400" name="l02400"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a29080d01ac5bc0d51ad407587c6721ab"> 2400</a></span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a29080d01ac5bc0d51ad407587c6721ab">m_rexmit_id</a>;</div>
<div class="line"><a id="l02401" name="l02401"></a><span class="lineno"> 2401</span><span class="comment"></span> </div>
<div class="line"><a id="l02402" name="l02402"></a><span class="lineno"> 2402</span><span class="comment">  /// When was it received?  Used for supplying delay before acknowledging (for other side&#39;s RTT calculations).</span></div>
<div class="line"><a id="l02403" name="l02403"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#ad6e1407a2a3fc95e568b00f31e423b25"> 2403</a></span><span class="comment"></span>  <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#ad6e1407a2a3fc95e568b00f31e423b25">m_received_when</a>;</div>
<div class="line"><a id="l02404" name="l02404"></a><span class="lineno"> 2404</span><span class="comment"></span> </div>
<div class="line"><a id="l02405" name="l02405"></a><span class="lineno"> 2405</span><span class="comment">  /// Number of bytes in the packet&#39;s user data.</span></div>
<div class="line"><a id="l02406" name="l02406"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a0af3081c75e1c552807ecc7af416efba"> 2406</a></span><span class="comment"></span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a0af3081c75e1c552807ecc7af416efba">m_data_size</a>;</div>
<div class="line"><a id="l02407" name="l02407"></a><span class="lineno"> 2407</span><span class="comment"></span> </div>
<div class="line"><a id="l02408" name="l02408"></a><span class="lineno"> 2408</span><span class="comment">  /// Make us noncopyable without breaking aggregateness (direct-init).</span></div>
<div class="line"><a id="l02409" name="l02409"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#af6ffacd3b12b70bf06b70bc8645315c5"> 2409</a></span><span class="comment"></span>  [[no_unique_address]] <a class="code hl_struct" href="structflow_1_1util_1_1Noncopyable.html">util::Noncopyable</a> <a class="code hl_variable" href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#af6ffacd3b12b70bf06b70bc8645315c5">m_nc</a>{};</div>
<div class="line"><a id="l02410" name="l02410"></a><span class="lineno"> 2410</span>}; <span class="comment">// struct Peer_socket::Individual_ack</span></div>
<div class="line"><a id="l02411" name="l02411"></a><span class="lineno"> 2411</span><span class="comment">// Note: Some static_assert()s about it currently in peer_socket.cpp in a function {} (for boring reasons).</span></div>
<div class="line"><a id="l02412" name="l02412"></a><span class="lineno"> 2412</span> </div>
<div class="line"><a id="l02413" name="l02413"></a><span class="lineno"> 2413</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l02414" name="l02414"></a><span class="lineno"> 2414</span> </div>
<div class="line"><a id="l02415" name="l02415"></a><span class="lineno"> 2415</span><span class="comment">// However the following refer to inner type(s) and hence must be declared here and not _fwd.hpp.</span></div>
<div class="line"><a id="l02416" name="l02416"></a><span class="lineno"> 2416</span><span class="comment"></span> </div>
<div class="line"><a id="l02417" name="l02417"></a><span class="lineno"> 2417</span><span class="comment">/**</span></div>
<div class="line"><a id="l02418" name="l02418"></a><span class="lineno"> 2418</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l02419" name="l02419"></a><span class="lineno"> 2419</span><span class="comment"> *</span></div>
<div class="line"><a id="l02420" name="l02420"></a><span class="lineno"> 2420</span><span class="comment"> * @todo There are a few guys like this which are marked `@internal` (Doxygen command) to hide from generated</span></div>
<div class="line"><a id="l02421" name="l02421"></a><span class="lineno"> 2421</span><span class="comment"> * public documentation, and that works, but really they should not be visible in the publicly-exported</span></div>
<div class="line"><a id="l02422" name="l02422"></a><span class="lineno"> 2422</span><span class="comment"> * (not in detail/) header source code; so this should be reorganized for cleanliness.  The prototypes like this one</span></div>
<div class="line"><a id="l02423" name="l02423"></a><span class="lineno"> 2423</span><span class="comment"> * can be moved to a detail/ header or maybe directly into .cpp that uses them (for those where it&#39;s only one).</span></div>
<div class="line"><a id="l02424" name="l02424"></a><span class="lineno"> 2424</span><span class="comment"> *</span></div>
<div class="line"><a id="l02425" name="l02425"></a><span class="lineno"> 2425</span><span class="comment"> * Prints string representation of given socket state to given standard `ostream` and returns the</span></div>
<div class="line"><a id="l02426" name="l02426"></a><span class="lineno"> 2426</span><span class="comment"> * latter.</span></div>
<div class="line"><a id="l02427" name="l02427"></a><span class="lineno"> 2427</span><span class="comment"> *</span></div>
<div class="line"><a id="l02428" name="l02428"></a><span class="lineno"> 2428</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l02429" name="l02429"></a><span class="lineno"> 2429</span><span class="comment"> *        Stream to print to.</span></div>
<div class="line"><a id="l02430" name="l02430"></a><span class="lineno"> 2430</span><span class="comment"> * @param state</span></div>
<div class="line"><a id="l02431" name="l02431"></a><span class="lineno"> 2431</span><span class="comment"> *        Value to serialize.</span></div>
<div class="line"><a id="l02432" name="l02432"></a><span class="lineno"> 2432</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l02433" name="l02433"></a><span class="lineno"> 2433</span><span class="comment"> */</span></div>
<div class="line"><a id="l02434" name="l02434"></a><span class="lineno"> 2434</span>std::ostream&amp; <a class="code hl_function" href="namespaceflow_1_1net__flow.html#ab9f537c84f77e9b8fa742fc5dc6d5693">operator&lt;&lt;</a>(std::ostream&amp; os, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Peer__socket.html#a9537860c2c2a7380a45a525e5121880f">Peer_socket::Int_state</a> state);</div>
<div class="line"><a id="l02435" name="l02435"></a><span class="lineno"> 2435</span> </div>
<div class="line"><a id="l02436" name="l02436"></a><span class="lineno"> 2436</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l02437" name="l02437"></a><span class="lineno"> 2437</span> </div>
<div class="line"><a id="l02438" name="l02438"></a><span class="lineno"> 2438</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Const_buffer_sequence&gt;</div>
<div class="line"><a id="l02439" name="l02439"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#af90b656d7e0b7e746b8beb4e24717cec"> 2439</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#af90b656d7e0b7e746b8beb4e24717cec">Peer_socket::send</a>(<span class="keyword">const</span> Const_buffer_sequence&amp; data, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l02440" name="l02440"></a><span class="lineno"> 2440</span>{</div>
<div class="line"><a id="l02441" name="l02441"></a><span class="lineno"> 2441</span>  <a class="code hl_define" href="error_2error_8hpp.html#a636b2d30a8785df6e84646b568bce9b5">FLOW_ERROR_EXEC_AND_THROW_ON_ERROR</a>(<span class="keywordtype">size_t</span>, send&lt;Const_buffer_sequence&gt;, data, _1);</div>
<div class="line"><a id="l02442" name="l02442"></a><span class="lineno"> 2442</span>  <span class="comment">// ^-- Call ourselves and return if err_code is null.  If got to present line, err_code is not null.</span></div>
<div class="line"><a id="l02443" name="l02443"></a><span class="lineno"> 2443</span> </div>
<div class="line"><a id="l02444" name="l02444"></a><span class="lineno"> 2444</span>  <span class="comment">// We are in user thread U != W.</span></div>
<div class="line"><a id="l02445" name="l02445"></a><span class="lineno"> 2445</span> </div>
<div class="line"><a id="l02446" name="l02446"></a><span class="lineno"> 2446</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a90abde8badaf451ba6ca615e9936d5df">Lock_guard</a> lock(<a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ab41b19ed4e62cb14fcd7dac81e4a8f41">m_mutex</a>); <span class="comment">// Lock m_node; also it&#39;s a pre-condition for Node::send().</span></div>
<div class="line"><a id="l02447" name="l02447"></a><span class="lineno"> 2447</span> </div>
<div class="line"><a id="l02448" name="l02448"></a><span class="lineno"> 2448</span>  <span class="comment">/* Forward the rest of the logic to Node.</span></div>
<div class="line"><a id="l02449" name="l02449"></a><span class="lineno"> 2449</span><span class="comment">   * Now, what I really want to do here is simply:</span></div>
<div class="line"><a id="l02450" name="l02450"></a><span class="lineno"> 2450</span><span class="comment">   *     m_node-&gt;send(this, data, err_code);</span></div>
<div class="line"><a id="l02451" name="l02451"></a><span class="lineno"> 2451</span><span class="comment">   * I cannot, however, due to C++&#39;s circular reference BS (Node needs Peer_socket, Peer_socket needs Node,</span></div>
<div class="line"><a id="l02452" name="l02452"></a><span class="lineno"> 2452</span><span class="comment">   * and both send()s are templates so cannot be implemented in .cpp).  So I perform the following</span></div>
<div class="line"><a id="l02453" name="l02453"></a><span class="lineno"> 2453</span><span class="comment">   * voodoo.  The only part that must be defined in .hpp is the part that actually uses template</span></div>
<div class="line"><a id="l02454" name="l02454"></a><span class="lineno"> 2454</span><span class="comment">   * parameters.  The only part that uses template parameters is m_snd_buf-&gt;feed_bufs_copy().</span></div>
<div class="line"><a id="l02455" name="l02455"></a><span class="lineno"> 2455</span><span class="comment">   * Therefore I prepare a canned call to m_snd_buf-&gt;feed_bufs_copy(data, ...) and save it in a</span></div>
<div class="line"><a id="l02456" name="l02456"></a><span class="lineno"> 2456</span><span class="comment">   * function pointer (Function) to an untemplated, regular function that makes this canned</span></div>
<div class="line"><a id="l02457" name="l02457"></a><span class="lineno"> 2457</span><span class="comment">   * call.  Finally, I call an untemplated function in .cpp, which has full understanding of Node,</span></div>
<div class="line"><a id="l02458" name="l02458"></a><span class="lineno"> 2458</span><span class="comment">   * and pass the pre-canned thingie into that.  That guy finally calls Node::send(), passing along</span></div>
<div class="line"><a id="l02459" name="l02459"></a><span class="lineno"> 2459</span><span class="comment">   * the precanned thingie.  Node::send() can then call the latter when it needs to feed() to the</span></div>
<div class="line"><a id="l02460" name="l02460"></a><span class="lineno"> 2460</span><span class="comment">   * buffer.  Therefore Node::send() does not need to be templated.</span></div>
<div class="line"><a id="l02461" name="l02461"></a><span class="lineno"> 2461</span><span class="comment">   *</span></div>
<div class="line"><a id="l02462" name="l02462"></a><span class="lineno"> 2462</span><span class="comment">   * Yeah, I know.  I had to do it though.  Logic should be in Node, not in Peer_socket.</span></div>
<div class="line"><a id="l02463" name="l02463"></a><span class="lineno"> 2463</span><span class="comment">   *</span></div>
<div class="line"><a id="l02464" name="l02464"></a><span class="lineno"> 2464</span><span class="comment">   * Update: As of this writing I&#39;ve added a formal @todo into Node doc header.  .inl tricks a-la-Boost might</span></div>
<div class="line"><a id="l02465" name="l02465"></a><span class="lineno"> 2465</span><span class="comment">   * help avoid this issue. */</span></div>
<div class="line"><a id="l02466" name="l02466"></a><span class="lineno"> 2466</span>  <span class="keyword">const</span> <span class="keyword">auto</span> snd_buf_feed_func = [<span class="keyword">this</span>, &amp;data](<span class="keywordtype">size_t</span> max_data_size)</div>
<div class="line"><a id="l02467" name="l02467"></a><span class="lineno"> 2467</span>  {</div>
<div class="line"><a id="l02468" name="l02468"></a><span class="lineno"> 2468</span>    <span class="keywordflow">return</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a993edf95f6bce2e57e7111e42533dc74">m_snd_buf</a>.<a class="code hl_function" href="classflow_1_1net__flow_1_1Socket__buffer.html#a69a0c514df820c36e7109fb1fcf78522">feed_bufs_copy</a>(data, max_data_size);</div>
<div class="line"><a id="l02469" name="l02469"></a><span class="lineno"> 2469</span>  };</div>
<div class="line"><a id="l02470" name="l02470"></a><span class="lineno"> 2470</span>  <span class="comment">// ^-- Important to capture `&amp;data`, not `data`; else `data` (albeit not actual payload) will be copied!</span></div>
<div class="line"><a id="l02471" name="l02471"></a><span class="lineno"> 2471</span> </div>
<div class="line"><a id="l02472" name="l02472"></a><span class="lineno"> 2472</span>  <span class="comment">/* Let this untemplated function, in .cpp, deal with Node (since .cpp knows what *m_node really is).</span></div>
<div class="line"><a id="l02473" name="l02473"></a><span class="lineno"> 2473</span><span class="comment">   * Note: whatever contraption lambda generated above will be converted to a Function&lt;...&gt; with ... being</span></div>
<div class="line"><a id="l02474" name="l02474"></a><span class="lineno"> 2474</span><span class="comment">   * an appropriate signature that node_send() expects, seen in the above explanatory comment. */</span></div>
<div class="line"><a id="l02475" name="l02475"></a><span class="lineno"> 2475</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a83ba2b4c39555afad67932ea6ed39bbe">node_send</a>(snd_buf_feed_func, err_code);</div>
<div class="line"><a id="l02476" name="l02476"></a><span class="lineno"> 2476</span>} <span class="comment">// Peer_socket::send()</span></div>
<div class="line"><a id="l02477" name="l02477"></a><span class="lineno"> 2477</span> </div>
<div class="line"><a id="l02478" name="l02478"></a><span class="lineno"> 2478</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Const_buffer_sequence&gt;</div>
<div class="line"><a id="l02479" name="l02479"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a6b9fa02a7c41b52fde9e05e862a9d20f"> 2479</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a70629642551f18e474b87c128d2d77e2">Peer_socket::sync_send</a>(<span class="keyword">const</span> Const_buffer_sequence&amp; data, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l02480" name="l02480"></a><span class="lineno"> 2480</span>{</div>
<div class="line"><a id="l02481" name="l02481"></a><span class="lineno"> 2481</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a3f1a802024549a59978a53343b09a86d">sync_send_impl</a>(data, <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>(), err_code); <span class="comment">// sync_send() with infinite timeout.</span></div>
<div class="line"><a id="l02482" name="l02482"></a><span class="lineno"> 2482</span>}</div>
<div class="line"><a id="l02483" name="l02483"></a><span class="lineno"> 2483</span> </div>
<div class="line"><a id="l02484" name="l02484"></a><span class="lineno"> 2484</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period, <span class="keyword">typename</span> Const_buffer_sequence&gt;</div>
<div class="line"><a id="l02485" name="l02485"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a70629642551f18e474b87c128d2d77e2"> 2485</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a70629642551f18e474b87c128d2d77e2">Peer_socket::sync_send</a>(<span class="keyword">const</span> Const_buffer_sequence&amp; data,</div>
<div class="line"><a id="l02486" name="l02486"></a><span class="lineno"> 2486</span>                              <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait,</div>
<div class="line"><a id="l02487" name="l02487"></a><span class="lineno"> 2487</span>                              <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l02488" name="l02488"></a><span class="lineno"> 2488</span>{</div>
<div class="line"><a id="l02489" name="l02489"></a><span class="lineno"> 2489</span>  assert(max_wait.count() &gt; 0);</div>
<div class="line"><a id="l02490" name="l02490"></a><span class="lineno"> 2490</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a3f1a802024549a59978a53343b09a86d">sync_send_impl</a>(data,</div>
<div class="line"><a id="l02491" name="l02491"></a><span class="lineno"> 2491</span>                        <a class="code hl_function" href="namespaceflow_1_1util.html#a5488415feb5570a6551892a7bdfeeec4">util::chrono_duration_from_now_to_fine_time_pt</a>(max_wait),</div>
<div class="line"><a id="l02492" name="l02492"></a><span class="lineno"> 2492</span>                        err_code);</div>
<div class="line"><a id="l02493" name="l02493"></a><span class="lineno"> 2493</span>}</div>
<div class="line"><a id="l02494" name="l02494"></a><span class="lineno"> 2494</span> </div>
<div class="line"><a id="l02495" name="l02495"></a><span class="lineno"> 2495</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period&gt;</div>
<div class="line"><a id="l02496" name="l02496"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#aa4c4e5917d693efdf4701962bdc35a0f"> 2496</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a70629642551f18e474b87c128d2d77e2">Peer_socket::sync_send</a>(std::nullptr_t,</div>
<div class="line"><a id="l02497" name="l02497"></a><span class="lineno"> 2497</span>                            <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait,</div>
<div class="line"><a id="l02498" name="l02498"></a><span class="lineno"> 2498</span>                            <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l02499" name="l02499"></a><span class="lineno"> 2499</span>{</div>
<div class="line"><a id="l02500" name="l02500"></a><span class="lineno"> 2500</span>  assert(max_wait.count() &gt; 0);</div>
<div class="line"><a id="l02501" name="l02501"></a><span class="lineno"> 2501</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a15ba1d4af6d4e3fcab9534a307c00595">sync_send_reactor_pattern_impl</a>(<a class="code hl_function" href="namespaceflow_1_1util.html#a5488415feb5570a6551892a7bdfeeec4">util::chrono_duration_from_now_to_fine_time_pt</a>(max_wait),</div>
<div class="line"><a id="l02502" name="l02502"></a><span class="lineno"> 2502</span>                                        err_code);</div>
<div class="line"><a id="l02503" name="l02503"></a><span class="lineno"> 2503</span>}</div>
<div class="line"><a id="l02504" name="l02504"></a><span class="lineno"> 2504</span> </div>
<div class="line"><a id="l02505" name="l02505"></a><span class="lineno"> 2505</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Const_buffer_sequence&gt;</div>
<div class="line"><a id="l02506" name="l02506"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a3f1a802024549a59978a53343b09a86d"> 2506</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a3f1a802024549a59978a53343b09a86d">Peer_socket::sync_send_impl</a>(<span class="keyword">const</span> Const_buffer_sequence&amp; data, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until,</div>
<div class="line"><a id="l02507" name="l02507"></a><span class="lineno"> 2507</span>                                   <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l02508" name="l02508"></a><span class="lineno"> 2508</span>{</div>
<div class="line"><a id="l02509" name="l02509"></a><span class="lineno"> 2509</span>  <a class="code hl_define" href="error_2error_8hpp.html#a636b2d30a8785df6e84646b568bce9b5">FLOW_ERROR_EXEC_AND_THROW_ON_ERROR</a>(<span class="keywordtype">size_t</span>, sync_send_impl&lt;Const_buffer_sequence&gt;, data, wait_until, _1);</div>
<div class="line"><a id="l02510" name="l02510"></a><span class="lineno"> 2510</span>  <span class="comment">// ^-- Call ourselves and return if err_code is null.  If got to present line, err_code is not null.</span></div>
<div class="line"><a id="l02511" name="l02511"></a><span class="lineno"> 2511</span> </div>
<div class="line"><a id="l02512" name="l02512"></a><span class="lineno"> 2512</span>  <span class="comment">// We are in user thread U != W.</span></div>
<div class="line"><a id="l02513" name="l02513"></a><span class="lineno"> 2513</span> </div>
<div class="line"><a id="l02514" name="l02514"></a><span class="lineno"> 2514</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a90abde8badaf451ba6ca615e9936d5df">Lock_guard</a> lock(<a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ab41b19ed4e62cb14fcd7dac81e4a8f41">m_mutex</a>); <span class="comment">// Lock m_node; also it&#39;s a pre-condition for Node::send().</span></div>
<div class="line"><a id="l02515" name="l02515"></a><span class="lineno"> 2515</span> </div>
<div class="line"><a id="l02516" name="l02516"></a><span class="lineno"> 2516</span>  <span class="comment">/* Forward the rest of the logic to Node.</span></div>
<div class="line"><a id="l02517" name="l02517"></a><span class="lineno"> 2517</span><span class="comment">   * Now, what I really want to do here is simply:</span></div>
<div class="line"><a id="l02518" name="l02518"></a><span class="lineno"> 2518</span><span class="comment">   *     m_node-&gt;sync_send(...args...);</span></div>
<div class="line"><a id="l02519" name="l02519"></a><span class="lineno"> 2519</span><span class="comment">   * I cannot, however, due to &lt;see same situation explained in Peer_socket::send()&gt;.</span></div>
<div class="line"><a id="l02520" name="l02520"></a><span class="lineno"> 2520</span><span class="comment">   * Therefore I do the following (&lt;see Peer_socket::send() for more comments&gt;). */</span></div>
<div class="line"><a id="l02521" name="l02521"></a><span class="lineno"> 2521</span> </div>
<div class="line"><a id="l02522" name="l02522"></a><span class="lineno"> 2522</span>  <span class="keyword">const</span> <span class="keyword">auto</span> snd_buf_feed_func = [<span class="keyword">this</span>, &amp;data](<span class="keywordtype">size_t</span> max_data_size)</div>
<div class="line"><a id="l02523" name="l02523"></a><span class="lineno"> 2523</span>  {</div>
<div class="line"><a id="l02524" name="l02524"></a><span class="lineno"> 2524</span>    <span class="keywordflow">return</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#a993edf95f6bce2e57e7111e42533dc74">m_snd_buf</a>.<a class="code hl_function" href="classflow_1_1net__flow_1_1Socket__buffer.html#a69a0c514df820c36e7109fb1fcf78522">feed_bufs_copy</a>(data, max_data_size);</div>
<div class="line"><a id="l02525" name="l02525"></a><span class="lineno"> 2525</span>  };</div>
<div class="line"><a id="l02526" name="l02526"></a><span class="lineno"> 2526</span>  <span class="comment">// ^-- Important to capture `&amp;data`, not `data`; else `data` (albeit not actual payload) will be copied!</span></div>
<div class="line"><a id="l02527" name="l02527"></a><span class="lineno"> 2527</span> </div>
<div class="line"><a id="l02528" name="l02528"></a><span class="lineno"> 2528</span>  lock.release(); <span class="comment">// Let go of the mutex (mutex is still LOCKED).</span></div>
<div class="line"><a id="l02529" name="l02529"></a><span class="lineno"> 2529</span>  <span class="comment">/* Let this untemplated function, in .cpp, deal with Node (since .cpp knows what *m_node really is).</span></div>
<div class="line"><a id="l02530" name="l02530"></a><span class="lineno"> 2530</span><span class="comment">   * Note: whatever contraption lambda generated above will be converted to a Function&lt;...&gt; with ... being</span></div>
<div class="line"><a id="l02531" name="l02531"></a><span class="lineno"> 2531</span><span class="comment">   * an appropriate signature that node_sync_send() expects, seen in the above explanatory comment. */</span></div>
<div class="line"><a id="l02532" name="l02532"></a><span class="lineno"> 2532</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a34e2c7dfb5596269a6f86a716015f1a6">node_sync_send</a>(snd_buf_feed_func, wait_until, err_code);</div>
<div class="line"><a id="l02533" name="l02533"></a><span class="lineno"> 2533</span>} <span class="comment">// Peer_socket::sync_send_impl()</span></div>
<div class="line"><a id="l02534" name="l02534"></a><span class="lineno"> 2534</span> </div>
<div class="line"><a id="l02535" name="l02535"></a><span class="lineno"> 2535</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Mutable_buffer_sequence&gt;</div>
<div class="line"><a id="l02536" name="l02536"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#aeb88e9253cc3f52269cb762c8e57e6d0"> 2536</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#aeb88e9253cc3f52269cb762c8e57e6d0">Peer_socket::receive</a>(<span class="keyword">const</span> Mutable_buffer_sequence&amp; target, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l02537" name="l02537"></a><span class="lineno"> 2537</span>{</div>
<div class="line"><a id="l02538" name="l02538"></a><span class="lineno"> 2538</span>  <a class="code hl_define" href="error_2error_8hpp.html#a636b2d30a8785df6e84646b568bce9b5">FLOW_ERROR_EXEC_AND_THROW_ON_ERROR</a>(<span class="keywordtype">size_t</span>, receive&lt;Mutable_buffer_sequence&gt;, target, _1);</div>
<div class="line"><a id="l02539" name="l02539"></a><span class="lineno"> 2539</span>  <span class="comment">// ^-- Call ourselves and return if err_code is null.  If got to present line, err_code is not null.</span></div>
<div class="line"><a id="l02540" name="l02540"></a><span class="lineno"> 2540</span> </div>
<div class="line"><a id="l02541" name="l02541"></a><span class="lineno"> 2541</span>  <span class="comment">// We are in user thread U != W.</span></div>
<div class="line"><a id="l02542" name="l02542"></a><span class="lineno"> 2542</span> </div>
<div class="line"><a id="l02543" name="l02543"></a><span class="lineno"> 2543</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a90abde8badaf451ba6ca615e9936d5df">Lock_guard</a> lock(<a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ab41b19ed4e62cb14fcd7dac81e4a8f41">m_mutex</a>);  <span class="comment">// Lock m_node/m_state; also it&#39;s a pre-condition for Node::receive().</span></div>
<div class="line"><a id="l02544" name="l02544"></a><span class="lineno"> 2544</span> </div>
<div class="line"><a id="l02545" name="l02545"></a><span class="lineno"> 2545</span>  <span class="comment">/* Forward the rest of the logic to Node.</span></div>
<div class="line"><a id="l02546" name="l02546"></a><span class="lineno"> 2546</span><span class="comment">   * Now, what I really want to do here is simply:</span></div>
<div class="line"><a id="l02547" name="l02547"></a><span class="lineno"> 2547</span><span class="comment">   *     m_node-&gt;receive(this, target), err_code);</span></div>
<div class="line"><a id="l02548" name="l02548"></a><span class="lineno"> 2548</span><span class="comment">   * I cannot, however, due to &lt;see same situation explained in Peer_socket::send()&gt;.</span></div>
<div class="line"><a id="l02549" name="l02549"></a><span class="lineno"> 2549</span><span class="comment">   * Therefore I do the following (&lt;see Peer_socket::send() for more comments&gt;). */</span></div>
<div class="line"><a id="l02550" name="l02550"></a><span class="lineno"> 2550</span> </div>
<div class="line"><a id="l02551" name="l02551"></a><span class="lineno"> 2551</span>  <span class="keyword">const</span> <span class="keyword">auto</span> rcv_buf_consume_func = [<span class="keyword">this</span>, &amp;target]()</div>
<div class="line"><a id="l02552" name="l02552"></a><span class="lineno"> 2552</span>  {</div>
<div class="line"><a id="l02553" name="l02553"></a><span class="lineno"> 2553</span>    <span class="comment">// Ensure that if there are data in Receive buffer, we will return at least 1 block as</span></div>
<div class="line"><a id="l02554" name="l02554"></a><span class="lineno"> 2554</span>    <span class="comment">// advertised.  @todo: I don&#39;t understand this comment now.  What does it mean?  Explain.</span></div>
<div class="line"><a id="l02555" name="l02555"></a><span class="lineno"> 2555</span>    <span class="keywordflow">return</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#aae9cb8f2dbd50ddaa0265d940b149ef3">m_rcv_buf</a>.<a class="code hl_function" href="classflow_1_1net__flow_1_1Socket__buffer.html#af60133c1d6825246b54f10f26810cd88">consume_bufs_copy</a>(target);</div>
<div class="line"><a id="l02556" name="l02556"></a><span class="lineno"> 2556</span>  };</div>
<div class="line"><a id="l02557" name="l02557"></a><span class="lineno"> 2557</span>  <span class="comment">// ^-- Important to capture `&amp;target`, not `target`; else `target` (albeit no actual buffers) will be copied!</span></div>
<div class="line"><a id="l02558" name="l02558"></a><span class="lineno"> 2558</span> </div>
<div class="line"><a id="l02559" name="l02559"></a><span class="lineno"> 2559</span>  <span class="comment">/* Let this untemplated function, in .cpp, deal with Node (since .cpp knows what *m_node really is).</span></div>
<div class="line"><a id="l02560" name="l02560"></a><span class="lineno"> 2560</span><span class="comment">   * Note: whatever contraption lambda generated above will be converted to a Function&lt;...&gt; with ... being</span></div>
<div class="line"><a id="l02561" name="l02561"></a><span class="lineno"> 2561</span><span class="comment">   * an appropriate signature that node_receive() expects, seen in the above explanatory comment. */</span></div>
<div class="line"><a id="l02562" name="l02562"></a><span class="lineno"> 2562</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#af3ac1b0b3c9b1c3a5ec246148595c657">node_receive</a>(rcv_buf_consume_func, err_code);</div>
<div class="line"><a id="l02563" name="l02563"></a><span class="lineno"> 2563</span>}</div>
<div class="line"><a id="l02564" name="l02564"></a><span class="lineno"> 2564</span> </div>
<div class="line"><a id="l02565" name="l02565"></a><span class="lineno"> 2565</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Mutable_buffer_sequence&gt;</div>
<div class="line"><a id="l02566" name="l02566"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#af5143886b33b4f16e4fbfbe3a4e91e44"> 2566</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a256b77e546fff9394ef8d509e2ae771b">Peer_socket::sync_receive</a>(<span class="keyword">const</span> Mutable_buffer_sequence&amp; target, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l02567" name="l02567"></a><span class="lineno"> 2567</span>{</div>
<div class="line"><a id="l02568" name="l02568"></a><span class="lineno"> 2568</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#ad29f61b9885b10ddc3846cdae0560518">sync_receive_impl</a>(target, <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>(), err_code); <span class="comment">// sync_receive() with infinite timeout.</span></div>
<div class="line"><a id="l02569" name="l02569"></a><span class="lineno"> 2569</span>}</div>
<div class="line"><a id="l02570" name="l02570"></a><span class="lineno"> 2570</span> </div>
<div class="line"><a id="l02571" name="l02571"></a><span class="lineno"> 2571</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period, <span class="keyword">typename</span> Mutable_buffer_sequence&gt;</div>
<div class="line"><a id="l02572" name="l02572"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a256b77e546fff9394ef8d509e2ae771b"> 2572</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a256b77e546fff9394ef8d509e2ae771b">Peer_socket::sync_receive</a>(<span class="keyword">const</span> Mutable_buffer_sequence&amp; target,</div>
<div class="line"><a id="l02573" name="l02573"></a><span class="lineno"> 2573</span>                                 <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l02574" name="l02574"></a><span class="lineno"> 2574</span>{</div>
<div class="line"><a id="l02575" name="l02575"></a><span class="lineno"> 2575</span>  assert(max_wait.count() &gt; 0);</div>
<div class="line"><a id="l02576" name="l02576"></a><span class="lineno"> 2576</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#ad29f61b9885b10ddc3846cdae0560518">sync_receive_impl</a>(target,</div>
<div class="line"><a id="l02577" name="l02577"></a><span class="lineno"> 2577</span>                           <a class="code hl_function" href="namespaceflow_1_1util.html#a5488415feb5570a6551892a7bdfeeec4">util::chrono_duration_from_now_to_fine_time_pt</a>(max_wait),</div>
<div class="line"><a id="l02578" name="l02578"></a><span class="lineno"> 2578</span>                           err_code);</div>
<div class="line"><a id="l02579" name="l02579"></a><span class="lineno"> 2579</span>}</div>
<div class="line"><a id="l02580" name="l02580"></a><span class="lineno"> 2580</span> </div>
<div class="line"><a id="l02581" name="l02581"></a><span class="lineno"> 2581</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period&gt;</div>
<div class="line"><a id="l02582" name="l02582"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#a34cc9ad4501bb8cefe2c4e946be88232"> 2582</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a256b77e546fff9394ef8d509e2ae771b">Peer_socket::sync_receive</a>(std::nullptr_t,</div>
<div class="line"><a id="l02583" name="l02583"></a><span class="lineno"> 2583</span>                               <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait,</div>
<div class="line"><a id="l02584" name="l02584"></a><span class="lineno"> 2584</span>                               <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l02585" name="l02585"></a><span class="lineno"> 2585</span>{</div>
<div class="line"><a id="l02586" name="l02586"></a><span class="lineno"> 2586</span>  assert(max_wait.count() &gt; 0);</div>
<div class="line"><a id="l02587" name="l02587"></a><span class="lineno"> 2587</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a1a2eccfa314a397c12259f414ef6798c">sync_receive_reactor_pattern_impl</a>(<a class="code hl_function" href="namespaceflow_1_1util.html#a5488415feb5570a6551892a7bdfeeec4">util::chrono_duration_from_now_to_fine_time_pt</a>(max_wait), err_code);</div>
<div class="line"><a id="l02588" name="l02588"></a><span class="lineno"> 2588</span>}</div>
<div class="line"><a id="l02589" name="l02589"></a><span class="lineno"> 2589</span> </div>
<div class="line"><a id="l02590" name="l02590"></a><span class="lineno"> 2590</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Mutable_buffer_sequence&gt;</div>
<div class="line"><a id="l02591" name="l02591"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#ad29f61b9885b10ddc3846cdae0560518"> 2591</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#ad29f61b9885b10ddc3846cdae0560518">Peer_socket::sync_receive_impl</a>(<span class="keyword">const</span> Mutable_buffer_sequence&amp; target,</div>
<div class="line"><a id="l02592" name="l02592"></a><span class="lineno"> 2592</span>                                      <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l02593" name="l02593"></a><span class="lineno"> 2593</span>{</div>
<div class="line"><a id="l02594" name="l02594"></a><span class="lineno"> 2594</span>  <a class="code hl_define" href="error_2error_8hpp.html#a636b2d30a8785df6e84646b568bce9b5">FLOW_ERROR_EXEC_AND_THROW_ON_ERROR</a>(<span class="keywordtype">size_t</span>, sync_receive_impl&lt;Mutable_buffer_sequence&gt;, target, wait_until, _1);</div>
<div class="line"><a id="l02595" name="l02595"></a><span class="lineno"> 2595</span>  <span class="comment">// ^-- Call ourselves and return if err_code is null.  If got to present line, err_code is not null.</span></div>
<div class="line"><a id="l02596" name="l02596"></a><span class="lineno"> 2596</span> </div>
<div class="line"><a id="l02597" name="l02597"></a><span class="lineno"> 2597</span>  <span class="comment">// We are in user thread U != W.</span></div>
<div class="line"><a id="l02598" name="l02598"></a><span class="lineno"> 2598</span> </div>
<div class="line"><a id="l02599" name="l02599"></a><span class="lineno"> 2599</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a90abde8badaf451ba6ca615e9936d5df">Lock_guard</a> lock(<a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#ab41b19ed4e62cb14fcd7dac81e4a8f41">m_mutex</a>); <span class="comment">// Lock m_node; also it&#39;s a pre-condition for Node::send().</span></div>
<div class="line"><a id="l02600" name="l02600"></a><span class="lineno"> 2600</span> </div>
<div class="line"><a id="l02601" name="l02601"></a><span class="lineno"> 2601</span>  <span class="comment">/* Forward the rest of the logic to Node.</span></div>
<div class="line"><a id="l02602" name="l02602"></a><span class="lineno"> 2602</span><span class="comment">   * Now, what I really want to do here is simply:</span></div>
<div class="line"><a id="l02603" name="l02603"></a><span class="lineno"> 2603</span><span class="comment">   *     m_node-&gt;sync_receive(...args...);</span></div>
<div class="line"><a id="l02604" name="l02604"></a><span class="lineno"> 2604</span><span class="comment">   * I cannot, however, due to &lt;see same situation explained in Peer_socket::send()&gt;.</span></div>
<div class="line"><a id="l02605" name="l02605"></a><span class="lineno"> 2605</span><span class="comment">   * Therefore I do the following (&lt;see Peer_socket::send() for more comments&gt;). */</span></div>
<div class="line"><a id="l02606" name="l02606"></a><span class="lineno"> 2606</span> </div>
<div class="line"><a id="l02607" name="l02607"></a><span class="lineno"> 2607</span>  <span class="keyword">const</span> <span class="keyword">auto</span> rcv_buf_consume_func = [<span class="keyword">this</span>, &amp;target]()</div>
<div class="line"><a id="l02608" name="l02608"></a><span class="lineno"> 2608</span>  {</div>
<div class="line"><a id="l02609" name="l02609"></a><span class="lineno"> 2609</span>    <span class="keywordflow">return</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#aae9cb8f2dbd50ddaa0265d940b149ef3">m_rcv_buf</a>.<a class="code hl_function" href="classflow_1_1net__flow_1_1Socket__buffer.html#af60133c1d6825246b54f10f26810cd88">consume_bufs_copy</a>(target);</div>
<div class="line"><a id="l02610" name="l02610"></a><span class="lineno"> 2610</span>  };</div>
<div class="line"><a id="l02611" name="l02611"></a><span class="lineno"> 2611</span>  <span class="comment">// ^-- Important to capture `&amp;target`, not `target`; else `target` (albeit no actual buffers) will be copied!</span></div>
<div class="line"><a id="l02612" name="l02612"></a><span class="lineno"> 2612</span> </div>
<div class="line"><a id="l02613" name="l02613"></a><span class="lineno"> 2613</span>  lock.release(); <span class="comment">// Let go of the mutex (mutex is still LOCKED).</span></div>
<div class="line"><a id="l02614" name="l02614"></a><span class="lineno"> 2614</span>  <span class="comment">/* Let this untemplated function, in .cpp, deal with Node (since .cpp knows what *m_node really is).</span></div>
<div class="line"><a id="l02615" name="l02615"></a><span class="lineno"> 2615</span><span class="comment">   * Note: whatever contraption lambda generated above will be converted to a Function&lt;...&gt; with ... being</span></div>
<div class="line"><a id="l02616" name="l02616"></a><span class="lineno"> 2616</span><span class="comment">   * an appropriate signature that node_sync_receive() expects, seen in the above explanatory comment. */</span></div>
<div class="line"><a id="l02617" name="l02617"></a><span class="lineno"> 2617</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#a8abde92d5189bf2a058fe8741789f814">node_sync_receive</a>(rcv_buf_consume_func, wait_until, err_code);</div>
<div class="line"><a id="l02618" name="l02618"></a><span class="lineno"> 2618</span>} <span class="comment">// Peer_socket::sync_receive()</span></div>
<div class="line"><a id="l02619" name="l02619"></a><span class="lineno"> 2619</span> </div>
<div class="line"><a id="l02620" name="l02620"></a><span class="lineno"> 2620</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Opt_type&gt;</div>
<div class="line"><a id="l02621" name="l02621"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Peer__socket.html#accf6d724ed1f145716ae3d4567f582f3"> 2621</a></span>Opt_type <a class="code hl_function" href="classflow_1_1net__flow_1_1Peer__socket.html#accf6d724ed1f145716ae3d4567f582f3">Peer_socket::opt</a>(<span class="keyword">const</span> Opt_type&amp; opt_val_ref)<span class="keyword"> const</span></div>
<div class="line"><a id="l02622" name="l02622"></a><span class="lineno"> 2622</span><span class="keyword"></span>{</div>
<div class="line"><a id="l02623" name="l02623"></a><span class="lineno"> 2623</span>  <span class="comment">// Similar to Node::opt().</span></div>
<div class="line"><a id="l02624" name="l02624"></a><span class="lineno"> 2624</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Peer__socket.html#a98c6729b318f28b61e144f8a9b1f4dfc">Options_lock</a> lock(<a class="code hl_variable" href="classflow_1_1net__flow_1_1Peer__socket.html#addfbe1487c621d4a9c464aec61bc108a">m_opts_mutex</a>);</div>
<div class="line"><a id="l02625" name="l02625"></a><span class="lineno"> 2625</span>  <span class="keywordflow">return</span> opt_val_ref;</div>
<div class="line"><a id="l02626" name="l02626"></a><span class="lineno"> 2626</span>}</div>
<div class="line"><a id="l02627" name="l02627"></a><span class="lineno"> 2627</span> </div>
<div class="line"><a id="l02628" name="l02628"></a><span class="lineno"> 2628</span>} <span class="comment">// namespace flow::net_flow</span></div>
<div class="line"><a id="l02629" name="l02629"></a><span class="lineno"> 2629</span> </div>
<div class="ttc" id="aclassflow_1_1Function_html"><div class="ttname"><a href="classflow_1_1Function.html">flow::Function</a></div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00512">common.hpp:512</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Log__context_html"><div class="ttname"><a href="classflow_1_1log_1_1Log__context.html">flow::log::Log_context</a></div><div class="ttdoc">Convenience class that simply stores a Logger and/or Component passed into a constructor; and returns...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01609">log.hpp:1610</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Logger_html"><div class="ttname"><a href="classflow_1_1log_1_1Logger.html">flow::log::Logger</a></div><div class="ttdoc">Interface that the user should implement, passing the implementing Logger into logging classes (Flow'...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01280">log.hpp:1284</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Congestion__control__classic__data_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Congestion__control__classic__data.html">flow::net_flow::Congestion_control_classic_data</a></div><div class="ttdoc">Utility class for use by Congestion_control_strategy implementations that implements congestion windo...</div><div class="ttdef"><b>Definition:</b> <a href="cong__ctl__util_8hpp_source.html#l00076">cong_ctl_util.hpp:79</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Congestion__control__classic__with__bandwidth__est_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Congestion__control__classic__with__bandwidth__est.html">flow::net_flow::Congestion_control_classic_with_bandwidth_est</a></div><div class="ttdoc">Classic congestion control but with backoff to bandwidth estimate-based pipe size.</div><div class="ttdef"><b>Definition:</b> <a href="cong__ctl__classic__bw_8hpp_source.html#l00061">cong_ctl_classic_bw.hpp:63</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Congestion__control__classic_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Congestion__control__classic.html">flow::net_flow::Congestion_control_classic</a></div><div class="ttdoc">Classic congestion control, based on Reno (TCP RFC 5681), with congestion avoidance,...</div><div class="ttdef"><b>Definition:</b> <a href="cong__ctl__classic_8hpp_source.html#l00063">cong_ctl_classic.hpp:65</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Drop__timer_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Drop__timer.html">flow::net_flow::Drop_timer</a></div><div class="ttdoc">Internal net_flow class that maintains the Drop Timer for DATA packet(s) to have been sent out over a...</div><div class="ttdef"><b>Definition:</b> <a href="drop__timer_8hpp_source.html#l00145">drop_timer.hpp:152</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Node_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Node.html">flow::net_flow::Node</a></div><div class="ttdoc">An object of this class is a single Flow-protocol networking node, in the sense that: (1) it has a di...</div><div class="ttdef"><b>Definition:</b> <a href="node_8hpp_source.html#l00930">node.hpp:934</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket__receive__stats__accumulator_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket__receive__stats__accumulator.html">flow::net_flow::Peer_socket_receive_stats_accumulator</a></div><div class="ttdoc">A class that keeps a Peer_socket_receive_stats data store, includes methods to conveniently accumulat...</div><div class="ttdef"><b>Definition:</b> <a href="socket__stats_8hpp_source.html#l00049">socket_stats.hpp:52</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket__send__stats__accumulator_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket__send__stats__accumulator.html">flow::net_flow::Peer_socket_send_stats_accumulator</a></div><div class="ttdoc">A class that keeps a Peer_socket_send_stats data store, includes methods to conveniently accumulate d...</div><div class="ttdef"><b>Definition:</b> <a href="socket__stats_8hpp_source.html#l00268">socket_stats.hpp:271</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html">flow::net_flow::Peer_socket</a></div><div class="ttdoc">A peer (non-server) socket operating over the Flow network protocol, with optional stream-of-bytes an...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00216">peer_socket.hpp:224</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a037459e6f1345cedf45e490d544c8567"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a037459e6f1345cedf45e490d544c8567">flow::net_flow::Peer_socket::m_snd_drop_timer</a></div><div class="ttdeci">Drop_timer_ptr m_snd_drop_timer</div><div class="ttdoc">The Drop Timer engine, which controls how In-flight (m_snd_flying_pkts_by_sent_when) packets are cons...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02048">peer_socket.hpp:2048</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a03ea7069aa4779abaf274989bd4c2fb6"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a03ea7069aa4779abaf274989bd4c2fb6">flow::net_flow::Peer_socket::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, Int_state state)</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l06436">peer_socket.cpp:6436</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a05a765055fd54412c63e57e43697f1bc"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a05a765055fd54412c63e57e43697f1bc">flow::net_flow::Peer_socket::m_state</a></div><div class="ttdeci">State m_state</div><div class="ttdoc">See state().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01189">peer_socket.hpp:1189</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a07d885e5c8ec85e7ef8718dc0468ffe9"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a07d885e5c8ec85e7ef8718dc0468ffe9">flow::net_flow::Peer_socket::m_snd_pending_rcv_wnd</a></div><div class="ttdeci">size_t m_snd_pending_rcv_wnd</div><div class="ttdoc">While Node::low_lvl_recv_and_handle() or async part of Node::async_wait_latency_then_handle_incoming(...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01613">peer_socket.hpp:1613</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a0c99637726b3c2b2ff1dbf14c6c92752"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a0c99637726b3c2b2ff1dbf14c6c92752">flow::net_flow::Peer_socket::get_connect_metadata</a></div><div class="ttdeci">size_t get_connect_metadata(const boost::asio::mutable_buffer &amp;buffer, Error_code *err_code=0) const</div><div class="ttdoc">Obtains the serialized connect metadata, as supplied by the user during the connection handshake.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00381">peer_socket.cpp:381</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a0d1eecb59c62912b5630359df774dc62"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a0d1eecb59c62912b5630359df774dc62">flow::net_flow::Peer_socket::m_init_rexmit_count</a></div><div class="ttdeci">unsigned int m_init_rexmit_count</div><div class="ttdoc">If currently using m_init_rexmit_scheduled_task, this is the number of times the timer has already fi...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02141">peer_socket.hpp:2141</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a102b78eaac9c8add512238ec5f26fcfc"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a102b78eaac9c8add512238ec5f26fcfc">flow::net_flow::Peer_socket::max_block_size_multiple</a></div><div class="ttdeci">size_t max_block_size_multiple(const size_t &amp;opt_val_ref, const unsigned int *inflate_pct_val_ptr=0) const</div><div class="ttdoc">Returns the smallest multiple of max_block_size() that is &gt;= the given option value,...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00348">peer_socket.cpp:348</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a12611e0ac9e8b86b8304b855050a8c8c"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a12611e0ac9e8b86b8304b855050a8c8c">flow::net_flow::Peer_socket::m_snd_remote_rcv_wnd</a></div><div class="ttdeci">size_t m_snd_remote_rcv_wnd</div><div class="ttdoc">The receive window: the maximum number of bytes the other side has advertised it would be willing to ...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01991">peer_socket.hpp:1991</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a13c640ebd14a75df3894e7d885d16f5f"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a13c640ebd14a75df3894e7d885d16f5f">flow::net_flow::Peer_socket::m_rcv_next_seq_num</a></div><div class="ttdeci">Sequence_number m_rcv_next_seq_num</div><div class="ttdoc">The maximal sequence number R from the remote side such that all data with sequence numbers strictly ...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01398">peer_socket.hpp:1398</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a1553bbefc3407cf84eaa8e256c6cffff"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a1553bbefc3407cf84eaa8e256c6cffff">flow::net_flow::Peer_socket::m_rcv_syn_rcvd_data_cumulative_size</a></div><div class="ttdeci">size_t m_rcv_syn_rcvd_data_cumulative_size</div><div class="ttdoc">The running total count of bytes in the m_data fields of m_rcv_syn_rcvd_data_q.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01373">peer_socket.hpp:1373</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a15ba1d4af6d4e3fcab9534a307c00595"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a15ba1d4af6d4e3fcab9534a307c00595">flow::net_flow::Peer_socket::sync_send_reactor_pattern_impl</a></div><div class="ttdeci">bool sync_send_reactor_pattern_impl(const Fine_time_pt &amp;wait_until, Error_code *err_code)</div><div class="ttdoc">Helper similar to sync_send_impl() but for the nullptr_t versions of sync_send().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00112">peer_socket.cpp:112</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a1869760d5cfc5c0d22665e5db88710e4"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a1869760d5cfc5c0d22665e5db88710e4">flow::net_flow::Peer_socket::Rcv_syn_rcvd_data_q</a></div><div class="ttdeci">std::vector&lt; boost::shared_ptr&lt; Data_packet &gt; &gt; Rcv_syn_rcvd_data_q</div><div class="ttdoc">Type used for m_rcv_syn_rcvd_data_q.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00978">peer_socket.hpp:978</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a1958264af0c40f3c9c5769ddff4c9ade"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a1958264af0c40f3c9c5769ddff4c9ade">flow::net_flow::Peer_socket::Sent_pkt_by_seq_num_map</a></div><div class="ttdeci">std::map&lt; Sequence_number, Sent_pkt_ordered_by_when_iter &gt; Sent_pkt_by_seq_num_map</div><div class="ttdoc">Short-hand for m_snd_flying_pkts_by_seq_num type; see that data member.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00946">peer_socket.hpp:946</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a1a2eccfa314a397c12259f414ef6798c"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a1a2eccfa314a397c12259f414ef6798c">flow::net_flow::Peer_socket::sync_receive_reactor_pattern_impl</a></div><div class="ttdeci">bool sync_receive_reactor_pattern_impl(const Fine_time_pt &amp;wait_until, Error_code *err_code)</div><div class="ttdoc">Helper similar to sync_receive_impl() but for the nullptr_t versions of sync_receive().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00193">peer_socket.cpp:193</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a1e1379f9a0269d6990f26bf1da045657"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a1e1379f9a0269d6990f26bf1da045657">flow::net_flow::Peer_socket::Options_mutex</a></div><div class="ttdeci">util::Mutex_non_recursive Options_mutex</div><div class="ttdoc">Short-hand for high-performance, non-reentrant, exclusive mutex used to lock m_opts.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00882">peer_socket.hpp:882</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a1ec79951579d595bb790be87189d6e6c"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a1ec79951579d595bb790be87189d6e6c">flow::net_flow::Peer_socket::m_snd_last_order_num</a></div><div class="ttdeci">order_num_t m_snd_last_order_num</div><div class="ttdoc">For the Sent_packet representing the next packet to be sent, this is the value to assign to m_sent_wh...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01926">peer_socket.hpp:1926</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a1f8bebf649551131e6ed6e75c6f98d54"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a1f8bebf649551131e6ed6e75c6f98d54">flow::net_flow::Peer_socket::m_snd_next_seq_num</a></div><div class="ttdeci">Sequence_number m_snd_next_seq_num</div><div class="ttdoc">The sequence number for the start of the data in the next new DATA packet to be sent out.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01699">peer_socket.hpp:1699</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a218ec098984b754b43940001f59ab787"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a218ec098984b754b43940001f59ab787">flow::net_flow::Peer_socket::m_remote_endpoint</a></div><div class="ttdeci">Remote_endpoint m_remote_endpoint</div><div class="ttdoc">See remote_endpoint(). Should be set before user gets access to *this and not changed afterwards.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01341">peer_socket.hpp:1341</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a256b77e546fff9394ef8d509e2ae771b"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a256b77e546fff9394ef8d509e2ae771b">flow::net_flow::Peer_socket::sync_receive</a></div><div class="ttdeci">size_t sync_receive(const Mutable_buffer_sequence &amp;target, const boost::chrono::duration&lt; Rep, Period &gt; &amp;max_wait, Error_code *err_code=0)</div><div class="ttdoc">Blocking (synchronous) version of receive().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02572">peer_socket.hpp:2572</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a27ce5b19ab4abcf61aa07153c46b2be3"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a27ce5b19ab4abcf61aa07153c46b2be3">flow::net_flow::Peer_socket::m_round_trip_time_variance</a></div><div class="ttdeci">Fine_duration m_round_trip_time_variance</div><div class="ttdoc">RTTVAR used for m_snd_smoothed_round_trip_time calculation.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02038">peer_socket.hpp:2038</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a288ccfc742d6982c4059d82500397874"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a288ccfc742d6982c4059d82500397874">flow::net_flow::Peer_socket::m_active_connect</a></div><div class="ttdeci">bool m_active_connect</div><div class="ttdoc">true if we connect() to server; false if we are to be/are accept()ed. Should be set once and not modi...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01181">peer_socket.hpp:1181</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a2c5de5df50268168cbbad82eaf90fa93"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a2c5de5df50268168cbbad82eaf90fa93">flow::net_flow::Peer_socket::m_int_state</a></div><div class="ttdeci">Int_state m_int_state</div><div class="ttdoc">Current internal state of the socket.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01353">peer_socket.hpp:1353</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a2d8aded3761028967fd3abb464e64936"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a2d8aded3761028967fd3abb464e64936">flow::net_flow::Peer_socket::m_snd_drop_timeout</a></div><div class="ttdeci">Fine_duration m_snd_drop_timeout</div><div class="ttdoc">The Drop Timeout: Time period between the next time m_snd_drop_timer schedules a Drop Timer and that ...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02058">peer_socket.hpp:2058</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a2db7d11ece920d4adcacd00eaa2253fd"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a2db7d11ece920d4adcacd00eaa2253fd">flow::net_flow::Peer_socket::m_snd_flying_pkts_by_seq_num</a></div><div class="ttdeci">Sent_pkt_by_seq_num_map m_snd_flying_pkts_by_seq_num</div><div class="ttdoc">The collection of all In-flight packets (including those queued up to send in pacing module),...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01876">peer_socket.hpp:1876</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a2dd08c5fed4d179e4fde3a632c084751"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a2dd08c5fed4d179e4fde3a632c084751">flow::net_flow::Peer_socket::m_snd_bandwidth_estimator</a></div><div class="ttdeci">boost::movelib::unique_ptr&lt; Send_bandwidth_estimator &gt; m_snd_bandwidth_estimator</div><div class="ttdoc">The outgoing available bandwidth estimator for this connection on this side.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02019">peer_socket.hpp:2019</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a322dddf34a06bb199dab02c993bad686"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a322dddf34a06bb199dab02c993bad686">flow::net_flow::Peer_socket::m_serialized_metadata</a></div><div class="ttdeci">util::Blob m_serialized_metadata</div><div class="ttdoc">If !m_active_connect, this contains the serialized metadata that the user supplied on the other side ...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01325">peer_socket.hpp:1325</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a33a90b123612cc2e6a119cfa95ba4f6d"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a33a90b123612cc2e6a119cfa95ba4f6d">flow::net_flow::Peer_socket::m_security_token</a></div><div class="ttdeci">security_token_t m_security_token</div><div class="ttdoc">Random security token used during SYN_ACK-SYN_ACK_ACK.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02114">peer_socket.hpp:2114</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a34e2c7dfb5596269a6f86a716015f1a6"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a34e2c7dfb5596269a6f86a716015f1a6">flow::net_flow::Peer_socket::node_sync_send</a></div><div class="ttdeci">size_t node_sync_send(const Function&lt; size_t(size_t max_data_size)&gt; &amp;snd_buf_feed_func_or_empty, const Fine_time_pt &amp;wait_until, Error_code *err_code)</div><div class="ttdoc">This is to sync_send() as node_send() is to send().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00145">peer_socket.cpp:145</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a35eb43f2b5d7dd46a941def4523f673c"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a35eb43f2b5d7dd46a941def4523f673c">flow::net_flow::Peer_socket::m_snd_cong_ctl</a></div><div class="ttdeci">boost::movelib::unique_ptr&lt; Congestion_control_strategy &gt; m_snd_cong_ctl</div><div class="ttdoc">The congestion control strategy in use for this connection on this side.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01974">peer_socket.hpp:1974</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a36ab27af6886c7699f9965a5eb296cd6"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a36ab27af6886c7699f9965a5eb296cd6">flow::net_flow::Peer_socket::m_node</a></div><div class="ttdeci">Node * m_node</div><div class="ttdoc">See node().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01214">peer_socket.hpp:1214</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a3f1a802024549a59978a53343b09a86d"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a3f1a802024549a59978a53343b09a86d">flow::net_flow::Peer_socket::sync_send_impl</a></div><div class="ttdeci">size_t sync_send_impl(const Const_buffer_sequence &amp;data, const Fine_time_pt &amp;wait_until, Error_code *err_code)</div><div class="ttdoc">Same as sync_send() but uses a Fine_clock-based Fine_duration non-template type for implementation co...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02506">peer_socket.hpp:2506</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a48320d96118a37626f1852626965e6ed"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a48320d96118a37626f1852626965e6ed">flow::net_flow::Peer_socket::m_rcv_syn_rcvd_data_q</a></div><div class="ttdeci">Rcv_syn_rcvd_data_q m_rcv_syn_rcvd_data_q</div><div class="ttdoc">The queue of DATA packets received while in Int_state::S_SYN_RCVD state before the Syn_ack_ack_packet...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01366">peer_socket.hpp:1366</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a4fb8e8df98efa023e8bd4bd825475a18"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a4fb8e8df98efa023e8bd4bd825475a18">flow::net_flow::Peer_socket::m_disconnect_cause</a></div><div class="ttdeci">Error_code m_disconnect_cause</div><div class="ttdoc">The Error_code causing disconnection (if one has occurred or is occurring) on this socket; otherwise ...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01309">peer_socket.hpp:1309</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a5003c554807f5b5b58989ad58be48d42"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a5003c554807f5b5b58989ad58be48d42">flow::net_flow::Peer_socket::Peer_socket</a></div><div class="ttdeci">Peer_socket(log::Logger *logger_ptr, util::Task_engine *task_engine, const Peer_socket_options &amp;opts)</div><div class="ttdoc">Constructs object; initializes most values to well-defined (0, empty, etc.) but not necessarily meani...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00037">peer_socket.cpp:37</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a5476d9206f997fc9119b2a80b078ee87"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a5476d9206f997fc9119b2a80b078ee87">flow::net_flow::Peer_socket::m_rcv_wnd_recovery_start_time</a></div><div class="ttdeci">Fine_time_pt m_rcv_wnd_recovery_start_time</div><div class="ttdoc">Time point at which m_rcv_in_rcv_wnd_recovery was last set to true.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01642">peer_socket.hpp:1642</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a55b44104a2c305b9679434ba623a7357"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a55b44104a2c305b9679434ba623a7357">flow::net_flow::Peer_socket::m_snd_pacing_data</a></div><div class="ttdeci">Send_pacing_data m_snd_pacing_data</div><div class="ttdoc">The state of outgoing packet pacing for this socket; segregated into a simple struct to keep Peer_soc...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02067">peer_socket.hpp:2067</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a5629d810d2c7252eaa2243e076dde83f"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a5629d810d2c7252eaa2243e076dde83f">flow::net_flow::Peer_socket::m_originating_serv</a></div><div class="ttdeci">Server_socket::Ptr m_originating_serv</div><div class="ttdoc">For sockets that come a Server_socket, this is the inverse of Server_socket::m_connecting_socks: it i...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01238">peer_socket.hpp:1238</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a59db68ed0c77a9f6e1a7aeeb3df2a6b9"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a59db68ed0c77a9f6e1a7aeeb3df2a6b9">flow::net_flow::Peer_socket::security_token_t</a></div><div class="ttdeci">uint64_t security_token_t</div><div class="ttdoc">Type used for m_security_token.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00899">peer_socket.hpp:899</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a5dc05d1f5deb71e1259c5d5aad1fcf84"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a5dc05d1f5deb71e1259c5d5aad1fcf84">flow::net_flow::Peer_socket::m_rcv_init_seq_num</a></div><div class="ttdeci">Sequence_number m_rcv_init_seq_num</div><div class="ttdoc">The Initial Sequence Number (ISN) contained in the original Syn_packet or Syn_ack_packet we received.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01383">peer_socket.hpp:1383</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a5e423a9fd18a45cc7cc5fc34af29161e"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a5e423a9fd18a45cc7cc5fc34af29161e">flow::net_flow::Peer_socket::remote_endpoint</a></div><div class="ttdeci">const Remote_endpoint &amp; remote_endpoint() const</div><div class="ttdoc">Intended other side of the connection (regardless of success, failure, or current State).</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00369">peer_socket.cpp:369</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a5ea56c54a98289211fef4a672432a2ad"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a5ea56c54a98289211fef4a672432a2ad">flow::net_flow::Peer_socket::m_snd_flying_pkts_by_sent_when</a></div><div class="ttdeci">Sent_pkt_by_sent_when_map m_snd_flying_pkts_by_sent_when</div><div class="ttdoc">The collection of all In-flight packets, indexed by sequence number and ordered from most to least re...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01802">peer_socket.hpp:1802</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a6a9bb727c8982f24bcf978c10c2c7345"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a6a9bb727c8982f24bcf978c10c2c7345">flow::net_flow::Peer_socket::State</a></div><div class="ttdeci">State</div><div class="ttdoc">State of a Peer_socket.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00229">peer_socket.hpp:230</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a6f48d01d1269c9d4260d972baa40e548"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a6f48d01d1269c9d4260d972baa40e548">flow::net_flow::Peer_socket::Open_sub_state</a></div><div class="ttdeci">Open_sub_state</div><div class="ttdoc">The sub-state of a Peer_socket when state is State::S_OPEN.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00238">peer_socket.hpp:239</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a70629642551f18e474b87c128d2d77e2"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a70629642551f18e474b87c128d2d77e2">flow::net_flow::Peer_socket::sync_send</a></div><div class="ttdeci">size_t sync_send(const Const_buffer_sequence &amp;data, const boost::chrono::duration&lt; Rep, Period &gt; &amp;max_wait, Error_code *err_code=0)</div><div class="ttdoc">Blocking (synchronous) version of send().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02485">peer_socket.hpp:2485</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a729af2cb3465b67b811d8e9438b5af5d"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a729af2cb3465b67b811d8e9438b5af5d">flow::net_flow::Peer_socket::~Peer_socket</a></div><div class="ttdeci">~Peer_socket() override</div><div class="ttdoc">Boring virtual destructor. Note that deletion is to be handled exclusively via shared_ptr,...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00077">peer_socket.cpp:77</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a74f6fd527766fdeb05a96c5c03729a00"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a74f6fd527766fdeb05a96c5c03729a00">flow::net_flow::Peer_socket::disconnect_cause</a></div><div class="ttdeci">Error_code disconnect_cause() const</div><div class="ttdoc">The error code that perviously caused state() to become State::S_CLOSED, or success code if state is ...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00101">peer_socket.cpp:101</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a780f86759f861a3a84de8c5c768736b7"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a780f86759f861a3a84de8c5c768736b7">flow::net_flow::Peer_socket::m_rcv_pending_acks_size_at_recv_handler_start</a></div><div class="ttdeci">size_t m_rcv_pending_acks_size_at_recv_handler_start</div><div class="ttdoc">Helper state, to be used while inside either Node::low_lvl_recv_and_handle() or async part of Node::a...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01577">peer_socket.hpp:1577</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a797a524b73e2626fcfefe1be64f4d481"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a797a524b73e2626fcfefe1be64f4d481">flow::net_flow::Peer_socket::order_num_t</a></div><div class="ttdeci">Sequence_number::seq_num_t order_num_t</div><div class="ttdoc">Short-hand for order number type. 0 is reserved. Caution: Keep in sync with Drop_timer::packet_id_t.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00902">peer_socket.hpp:902</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a7af387476aa0bdc6b3906c153d824acb"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a7af387476aa0bdc6b3906c153d824acb">flow::net_flow::Peer_socket::local_port</a></div><div class="ttdeci">flow_port_t local_port() const</div><div class="ttdoc">The local Flow-protocol port chosen by the Node (if active or passive open) or user (if passive open)...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00375">peer_socket.cpp:375</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a7b65c1b26e38a2ae614d9a12edfa57dd"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a7b65c1b26e38a2ae614d9a12edfa57dd">flow::net_flow::Peer_socket::m_local_port</a></div><div class="ttdeci">flow_port_t m_local_port</div><div class="ttdoc">See local_port(). Should be set before user gets access to *this and not changed afterwards.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01344">peer_socket.hpp:1344</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a7d1f1d381749473f7a2471b8be20d6a8"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a7d1f1d381749473f7a2471b8be20d6a8">flow::net_flow::Peer_socket::m_rcv_stats</a></div><div class="ttdeci">Peer_socket_receive_stats_accumulator m_rcv_stats</div><div class="ttdoc">Stats regarding incoming traffic (and resulting outgoing ACKs) for this connection so far.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01674">peer_socket.hpp:1674</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a7d31cf18a3c075873de1c46c0176e41f"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a7d31cf18a3c075873de1c46c0176e41f">flow::net_flow::Peer_socket::set_options</a></div><div class="ttdeci">bool set_options(const Peer_socket_options &amp;opts, Error_code *err_code=0)</div><div class="ttdoc">Dynamically replaces the current options set (options()) with the given options set.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00289">peer_socket.cpp:289</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a7fa76b609ef0aa5962d8de77338cf9ee"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a7fa76b609ef0aa5962d8de77338cf9ee">flow::net_flow::Peer_socket::m_rcv_last_sent_rcv_wnd</a></div><div class="ttdeci">size_t m_rcv_last_sent_rcv_wnd</div><div class="ttdoc">The last rcv_wnd value sent to the other side (in an ACK).</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01623">peer_socket.hpp:1623</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a8229396adfd306d15e8a05dac3fe8c29"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a8229396adfd306d15e8a05dac3fe8c29">flow::net_flow::Peer_socket::m_rcv_acked_packets</a></div><div class="ttdeci">std::vector&lt; Ack_packet::Individual_ack::Ptr &gt; m_rcv_acked_packets</div><div class="ttdoc">While Node::low_lvl_recv_and_handle() or async part of Node::async_wait_latency_then_handle_incoming(...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01601">peer_socket.hpp:1601</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a83ba2b4c39555afad67932ea6ed39bbe"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a83ba2b4c39555afad67932ea6ed39bbe">flow::net_flow::Peer_socket::node_send</a></div><div class="ttdeci">size_t node_send(const Function&lt; size_t(size_t max_data_size)&gt; &amp;snd_buf_feed_func, Error_code *err_code)</div><div class="ttdoc">Non-template helper for template send() that forwards the send() logic to Node::send().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00130">peer_socket.cpp:130</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a845f21b754ef641b65b1fe44727fb429"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a845f21b754ef641b65b1fe44727fb429">flow::net_flow::Peer_socket::m_snd_rexmit_q</a></div><div class="ttdeci">std::list&lt; boost::shared_ptr&lt; Sent_packet &gt; &gt; m_snd_rexmit_q</div><div class="ttdoc">If retransmission is on, this is the retransmission queue.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01943">peer_socket.hpp:1943</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a85b3d271527dbaa04b1d9f751631fd71"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a85b3d271527dbaa04b1d9f751631fd71">flow::net_flow::Peer_socket::m_init_rexmit_scheduled_task</a></div><div class="ttdeci">util::Scheduled_task_handle m_init_rexmit_scheduled_task</div><div class="ttdoc">Connection attempt scheduled task; fires if an individual connection request packet is not answered w...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02130">peer_socket.hpp:2130</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a88f967e74f8618c94088113e918ab52f"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a88f967e74f8618c94088113e918ab52f">flow::net_flow::Peer_socket::m_rcv_delayed_ack_timer</a></div><div class="ttdeci">util::Timer m_rcv_delayed_ack_timer</div><div class="ttdoc">Timer started, assuming delayed ACKs are enabled, when the first Individual_ack is placed onto an emp...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01671">peer_socket.hpp:1671</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a89d852e3722532d75006b024714a5cef"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a89d852e3722532d75006b024714a5cef">flow::net_flow::Peer_socket::rexmit_on</a></div><div class="ttdeci">bool rexmit_on() const</div><div class="ttdoc">Whether retransmission is enabled on this connection.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00364">peer_socket.cpp:364</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a8abde92d5189bf2a058fe8741789f814"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a8abde92d5189bf2a058fe8741789f814">flow::net_flow::Peer_socket::node_sync_receive</a></div><div class="ttdeci">size_t node_sync_receive(const Function&lt; size_t()&gt; &amp;rcv_buf_consume_func_or_empty, const Fine_time_pt &amp;wait_until, Error_code *err_code)</div><div class="ttdoc">This is to sync_receive() as node_receive() is to receive().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00226">peer_socket.cpp:226</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a90abde8badaf451ba6ca615e9936d5df"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a90abde8badaf451ba6ca615e9936d5df">flow::net_flow::Peer_socket::Lock_guard</a></div><div class="ttdeci">util::Lock_guard&lt; Mutex &gt; Lock_guard</div><div class="ttdoc">Short-hand for RAII lock guard of Mutex.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00896">peer_socket.hpp:896</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a9320421e96ab89e6528da6a28b008709"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a9320421e96ab89e6528da6a28b008709">flow::net_flow::Peer_socket::Sent_pkt_ordered_by_seq_iter</a></div><div class="ttdeci">Sent_pkt_by_seq_num_map::iterator Sent_pkt_ordered_by_seq_iter</div><div class="ttdoc">Short-hand for m_snd_flying_pkts_by_seq_num iterator type.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00952">peer_socket.hpp:952</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a9537860c2c2a7380a45a525e5121880f"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a9537860c2c2a7380a45a525e5121880f">flow::net_flow::Peer_socket::Int_state</a></div><div class="ttdeci">Int_state</div><div class="ttdoc">The state of the socket (and the connection from this end's point of view) for the internal state mac...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00910">peer_socket.hpp:911</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a98c6729b318f28b61e144f8a9b1f4dfc"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a98c6729b318f28b61e144f8a9b1f4dfc">flow::net_flow::Peer_socket::Options_lock</a></div><div class="ttdeci">util::Lock_guard&lt; Options_mutex &gt; Options_lock</div><div class="ttdoc">Short-hand for lock that acquires exclusive access to an Options_mutex.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00885">peer_socket.hpp:885</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a993edf95f6bce2e57e7111e42533dc74"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a993edf95f6bce2e57e7111e42533dc74">flow::net_flow::Peer_socket::m_snd_buf</a></div><div class="ttdeci">Socket_buffer m_snd_buf</div><div class="ttdoc">The Send buffer; user feeds data at the back; Node consumes data at the front.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01275">peer_socket.hpp:1275</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a9ab710704237f912eb219f9b8d574afc"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a9ab710704237f912eb219f9b8d574afc">flow::net_flow::Peer_socket::close_abruptly</a></div><div class="ttdeci">void close_abruptly(Error_code *err_code=0)</div><div class="ttdoc">Acts as if fatal error error::Code::S_USER_CLOSED_ABRUPTLY has been discovered on the connection.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00261">peer_socket.cpp:261</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_a9f5063c85a2070822cf69a530f0af1f5"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#a9f5063c85a2070822cf69a530f0af1f5">flow::net_flow::Peer_socket::m_snd_rexmit_q_size</a></div><div class="ttdeci">size_t m_snd_rexmit_q_size</div><div class="ttdoc">Equals m_snd_rexmit_q.size(). Kept since m_snd_rexmit_q.size() may be O(n) depending on implementatio...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01946">peer_socket.hpp:1946</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_aa1f821dde38a7aa572651730744edbd8"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#aa1f821dde38a7aa572651730744edbd8">flow::net_flow::Peer_socket::max_block_size</a></div><div class="ttdeci">size_t max_block_size() const</div><div class="ttdoc">The maximum number of bytes of user data per received or sent packet on this connection.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00343">peer_socket.cpp:343</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_aa7398394052c8e634365fb979c294644"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#aa7398394052c8e634365fb979c294644">flow::net_flow::Peer_socket::m_rcv_reassembly_q_data_size</a></div><div class="ttdeci">size_t m_rcv_reassembly_q_data_size</div><div class="ttdoc">With retransmission enabled, the sum of Received_packet::m_size over all packets stored in the reasse...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01542">peer_socket.hpp:1542</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_aa9e7e1be830c901bc7348742e79ba2e7"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#aa9e7e1be830c901bc7348742e79ba2e7">flow::net_flow::Peer_socket::node</a></div><div class="ttdeci">Node * node() const</div><div class="ttdoc">Node that produced this Peer_socket.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00095">peer_socket.cpp:95</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_aa9f77167af54cfe2921fab5fd143eff4"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#aa9f77167af54cfe2921fab5fd143eff4">flow::net_flow::Peer_socket::m_snd_last_loss_event_when</a></div><div class="ttdeci">Fine_time_pt m_snd_last_loss_event_when</div><div class="ttdoc">The last time that Node has detected a packet loss event and so informed m_snd_cong_ctl by calling th...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02084">peer_socket.hpp:2084</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_aad81cc16fc6f0d353fdc1379e1dd4712"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#aad81cc16fc6f0d353fdc1379e1dd4712">flow::net_flow::Peer_socket::info</a></div><div class="ttdeci">Peer_socket_info info() const</div><div class="ttdoc">Returns a structure containing the most up-to-date stats about this connection.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00314">peer_socket.cpp:314</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_aae9cb8f2dbd50ddaa0265d940b149ef3"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#aae9cb8f2dbd50ddaa0265d940b149ef3">flow::net_flow::Peer_socket::m_rcv_buf</a></div><div class="ttdeci">Socket_buffer m_rcv_buf</div><div class="ttdoc">The Receive buffer; Node feeds data at the back; user consumes data at the front.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01257">peer_socket.hpp:1257</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_aaec992a7a14368623cc03c4382d71107"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#aaec992a7a14368623cc03c4382d71107">flow::net_flow::Peer_socket::Recvd_pkt_iter</a></div><div class="ttdeci">Recvd_pkt_map::iterator Recvd_pkt_iter</div><div class="ttdoc">Short-hand for m_rcv_packets_with_gaps iterator type.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00968">peer_socket.hpp:968</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ab41b19ed4e62cb14fcd7dac81e4a8f41"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ab41b19ed4e62cb14fcd7dac81e4a8f41">flow::net_flow::Peer_socket::m_mutex</a></div><div class="ttdeci">Mutex m_mutex</div><div class="ttdoc">This object's mutex.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01338">peer_socket.hpp:1338</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ab4aff3e65ef9551b6c5ab890173b741e"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ab4aff3e65ef9551b6c5ab890173b741e">flow::net_flow::Peer_socket::m_snd_stats</a></div><div class="ttdeci">Peer_socket_send_stats_accumulator m_snd_stats</div><div class="ttdoc">Stats regarding outgoing traffic (and resulting incoming ACKs) for this connection so far.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02103">peer_socket.hpp:2103</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ab7dc3b752b67295c82919c2f87aed60b"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ab7dc3b752b67295c82919c2f87aed60b">flow::net_flow::Peer_socket::Sent_pkt_ordered_by_when_iter</a></div><div class="ttdeci">Sent_pkt_by_sent_when_map::iterator Sent_pkt_ordered_by_when_iter</div><div class="ttdoc">Short-hand for m_snd_flying_pkts_by_sent_when iterator type.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00943">peer_socket.hpp:943</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_abd6f3174914c3ec559954b4125f2f9dd"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#abd6f3174914c3ec559954b4125f2f9dd">flow::net_flow::Peer_socket::Sent_pkt_ordered_by_seq_const_iter</a></div><div class="ttdeci">Sent_pkt_by_seq_num_map::const_iterator Sent_pkt_ordered_by_seq_const_iter</div><div class="ttdoc">Short-hand for m_snd_flying_pkts_by_seq_num const iterator type.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00949">peer_socket.hpp:949</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ac4c942e1bb6c4dc4b24251f294a2f92d"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ac4c942e1bb6c4dc4b24251f294a2f92d">flow::net_flow::Peer_socket::m_info_on_close</a></div><div class="ttdeci">Peer_socket_info m_info_on_close</div><div class="ttdoc">This is the final set of stats collected at the time the socket was moved to S_CLOSED m_state.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02163">peer_socket.hpp:2163</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ac7cbefb99ae173bd5f355f5d082564ce"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ac7cbefb99ae173bd5f355f5d082564ce">flow::net_flow::Peer_socket::ensure_open</a></div><div class="ttdeci">bool ensure_open(Error_code *err_code) const</div><div class="ttdoc">Helper that is equivalent to Node::ensure_sock_open(this, err_code).</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00409">peer_socket.cpp:409</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ac974bdce3d2035d2af69078837f59482"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ac974bdce3d2035d2af69078837f59482">flow::net_flow::Peer_socket::Sent_pkt_ordered_by_when_const_iter</a></div><div class="ttdeci">Sent_pkt_by_sent_when_map::const_iterator Sent_pkt_ordered_by_when_const_iter</div><div class="ttdoc">Short-hand for m_snd_flying_pkts_by_sent_when const iterator type.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00940">peer_socket.hpp:940</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_aca66d1cb582ca027745d1ef847266cc4"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#aca66d1cb582ca027745d1ef847266cc4">flow::net_flow::Peer_socket::m_snd_init_seq_num</a></div><div class="ttdeci">Sequence_number m_snd_init_seq_num</div><div class="ttdoc">The Initial Sequence Number (ISN) used in our original SYN or SYN_ACK.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01685">peer_socket.hpp:1685</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_accf6d724ed1f145716ae3d4567f582f3"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#accf6d724ed1f145716ae3d4567f582f3">flow::net_flow::Peer_socket::opt</a></div><div class="ttdeci">Opt_type opt(const Opt_type &amp;opt_val_ref) const</div><div class="ttdoc">Analogous to Node::opt() but for per-socket options.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02621">peer_socket.hpp:2621</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_acd100a3c02fad5d9e00fcbc1f645f116"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#acd100a3c02fad5d9e00fcbc1f645f116">flow::net_flow::Peer_socket::bytes_blocks_str</a></div><div class="ttdeci">std::string bytes_blocks_str(size_t bytes) const</div><div class="ttdoc">Helper that, given a byte count, returns a string with that byte count and the number of max_block_si...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00414">peer_socket.cpp:414</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ad08b53052e7eedfa7a925258f5ef1cba"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ad08b53052e7eedfa7a925258f5ef1cba">flow::net_flow::Peer_socket::m_snd_smoothed_round_trip_time</a></div><div class="ttdeci">Fine_duration m_snd_smoothed_round_trip_time</div><div class="ttdoc">Estimated current round trip time of packets, computed as a smooth value over the past individual RTT...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02035">peer_socket.hpp:2035</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ad1e36619c78b15f46576a18678a4ee67"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ad1e36619c78b15f46576a18678a4ee67">flow::net_flow::Peer_socket::Mutex</a></div><div class="ttdeci">util::Mutex_recursive Mutex</div><div class="ttdoc">Short-hand for reentrant mutex type.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00893">peer_socket.hpp:893</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ad29f61b9885b10ddc3846cdae0560518"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ad29f61b9885b10ddc3846cdae0560518">flow::net_flow::Peer_socket::sync_receive_impl</a></div><div class="ttdeci">size_t sync_receive_impl(const Mutable_buffer_sequence &amp;target, const Fine_time_pt &amp;wait_until, Error_code *err_code)</div><div class="ttdoc">Same as sync_receive() but uses a Fine_clock-based Fine_duration non-template type for implementation...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02591">peer_socket.hpp:2591</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ad46ed439a3d118eb2b540e9f99a7b0ca"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ad46ed439a3d118eb2b540e9f99a7b0ca">flow::net_flow::Peer_socket::m_rcv_pending_acks</a></div><div class="ttdeci">std::vector&lt; boost::shared_ptr&lt; Individual_ack &gt; &gt; m_rcv_pending_acks</div><div class="ttdoc">The received packets to be acknowledged in the next low-level ACK packet to be sent to the other side...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01563">peer_socket.hpp:1563</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ad59c09f34003873a3c207cc590236773"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ad59c09f34003873a3c207cc590236773">flow::net_flow::Peer_socket::m_opts</a></div><div class="ttdeci">Peer_socket_options m_opts</div><div class="ttdoc">This socket's per-socket set of options.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01175">peer_socket.hpp:1175</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ad7414dfca4b869dd3a4e0de39195c69e"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ad7414dfca4b869dd3a4e0de39195c69e">flow::net_flow::Peer_socket::m_rcv_in_rcv_wnd_recovery</a></div><div class="ttdeci">bool m_rcv_in_rcv_wnd_recovery</div><div class="ttdoc">true indicates we are in a state where we've decided other side needs to be informed that our receive...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01633">peer_socket.hpp:1633</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ad772e56de286567c4b7a681907b5f285"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ad772e56de286567c4b7a681907b5f285">flow::net_flow::Peer_socket::m_connection_timeout_scheduled_task</a></div><div class="ttdeci">util::Scheduled_task_handle m_connection_timeout_scheduled_task</div><div class="ttdoc">Connection timeout scheduled task; fires if the entire initial connection process does not complete w...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02155">peer_socket.hpp:2155</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ad94e37c8cca01f801f13e9e0e0bc857d"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ad94e37c8cca01f801f13e9e0e0bc857d">flow::net_flow::Peer_socket::options</a></div><div class="ttdeci">Peer_socket_options options() const</div><div class="ttdoc">Copies this socket's option set and returns that copy.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00309">peer_socket.cpp:309</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_addfbe1487c621d4a9c464aec61bc108a"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#addfbe1487c621d4a9c464aec61bc108a">flow::net_flow::Peer_socket::m_opts_mutex</a></div><div class="ttdeci">Options_mutex m_opts_mutex</div><div class="ttdoc">The mutex protecting m_opts.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01178">peer_socket.hpp:1178</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_addfc181f4d43ab816b2ede9216bf9331"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#addfc181f4d43ab816b2ede9216bf9331">flow::net_flow::Peer_socket::Recvd_pkt_map</a></div><div class="ttdeci">std::map&lt; Sequence_number, boost::shared_ptr&lt; Received_packet &gt; &gt; Recvd_pkt_map</div><div class="ttdoc">Short-hand for m_rcv_packets_with_gaps type; see that data member.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00962">peer_socket.hpp:962</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ade41e13eb5176d833c7b1ea144612353"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ade41e13eb5176d833c7b1ea144612353">flow::net_flow::Peer_socket::Recvd_pkt_const_iter</a></div><div class="ttdeci">Recvd_pkt_map::const_iterator Recvd_pkt_const_iter</div><div class="ttdoc">Short-hand for m_rcv_packets_with_gaps const iterator type.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00965">peer_socket.hpp:965</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ae5d47460784cc20c9e44237edffaac95"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ae5d47460784cc20c9e44237edffaac95">flow::net_flow::Peer_socket::m_open_sub_state</a></div><div class="ttdeci">Open_sub_state m_open_sub_state</div><div class="ttdoc">See state().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01198">peer_socket.hpp:1198</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ae804be57cf09b9bf76eafa8ffff73de6"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ae804be57cf09b9bf76eafa8ffff73de6">flow::net_flow::Peer_socket::Drop_timer_ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; Drop_timer &gt; Drop_timer_ptr</div><div class="ttdoc">Short-hand for shared_ptr to immutable Drop_timer (can't use Drop_timer::Ptr due to C++ and circular ...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00853">peer_socket.hpp:853</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ae82958ed6d71be46b96eceaca6214143"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ae82958ed6d71be46b96eceaca6214143">flow::net_flow::Peer_socket::m_rcv_packets_with_gaps</a></div><div class="ttdeci">Recvd_pkt_map m_rcv_packets_with_gaps</div><div class="ttdoc">The sequence-number-ordered collection of all received-and-not-dropped-due-to-buffer-overflow packets...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01533">peer_socket.hpp:1533</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_ae870847f024fca7109c15557bb165480"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#ae870847f024fca7109c15557bb165480">flow::net_flow::Peer_socket::m_snd_flying_bytes</a></div><div class="ttdeci">size_t m_snd_flying_bytes</div><div class="ttdoc">The number of bytes contained in all In-flight packets, used at least for comparison against the cong...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01895">peer_socket.hpp:1895</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_aea98297d775f2085c21daf41c6582200"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#aea98297d775f2085c21daf41c6582200">flow::net_flow::Peer_socket::m_snd_temp_pkts_marked_to_drop</a></div><div class="ttdeci">std::vector&lt; order_num_t &gt; m_snd_temp_pkts_marked_to_drop</div><div class="ttdoc">Helper data structure to store the packet IDs of packets that are marked Dropped during a single run ...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01912">peer_socket.hpp:1912</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_aeb88e9253cc3f52269cb762c8e57e6d0"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#aeb88e9253cc3f52269cb762c8e57e6d0">flow::net_flow::Peer_socket::receive</a></div><div class="ttdeci">size_t receive(const Mutable_buffer_sequence &amp;target, Error_code *err_code=0)</div><div class="ttdoc">Receives (consumes from the Receive buffer) bytes of data, up to a given maximum cumulative number of...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02536">peer_socket.hpp:2536</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_af392484f79ffcead4f74ca351672d8d4"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#af392484f79ffcead4f74ca351672d8d4">flow::net_flow::Peer_socket::m_snd_last_data_sent_when</a></div><div class="ttdeci">Fine_time_pt m_snd_last_data_sent_when</div><div class="ttdoc">Time at which the last Data_packet low-level packet for this connection was sent.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02100">peer_socket.hpp:2100</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_af3ac1b0b3c9b1c3a5ec246148595c657"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#af3ac1b0b3c9b1c3a5ec246148595c657">flow::net_flow::Peer_socket::node_receive</a></div><div class="ttdeci">size_t node_receive(const Function&lt; size_t()&gt; &amp;rcv_buf_consume_func, Error_code *err_code)</div><div class="ttdoc">Non-template helper for template receive() that forwards the receive() logic to Node::receive().</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00211">peer_socket.cpp:211</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_af90b656d7e0b7e746b8beb4e24717cec"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#af90b656d7e0b7e746b8beb4e24717cec">flow::net_flow::Peer_socket::send</a></div><div class="ttdeci">size_t send(const Const_buffer_sequence &amp;data, Error_code *err_code=0)</div><div class="ttdoc">Sends (adds to the Send buffer) the given bytes of data up to a maximum internal buffer size; and asy...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02439">peer_socket.hpp:2439</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_af982953b5136c1df488066eacc293a78"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#af982953b5136c1df488066eacc293a78">flow::net_flow::Peer_socket::state</a></div><div class="ttdeci">State state(Open_sub_state *open_sub_state=0) const</div><div class="ttdoc">Current State of the socket.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00085">peer_socket.cpp:85</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html_afd590cc70d06b8e903027e4924fd095a"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html#afd590cc70d06b8e903027e4924fd095a">flow::net_flow::Peer_socket::m_rcv_wnd_recovery_scheduled_task</a></div><div class="ttdeci">util::Scheduled_task_handle m_rcv_wnd_recovery_scheduled_task</div><div class="ttdoc">When m_rcv_in_rcv_wnd_recovery is true, this is the scheduled task to possibly send another unsolicit...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l01651">peer_socket.hpp:1651</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Send__bandwidth__estimator_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Send__bandwidth__estimator.html">flow::net_flow::Send_bandwidth_estimator</a></div><div class="ttdoc">A per-Peer_socket module that tries to estimate the bandwidth available to the outgoing flow.</div><div class="ttdef"><b>Definition:</b> <a href="bandwidth_8hpp_source.html#l00122">bandwidth.hpp:125</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Sequence__number_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Sequence__number.html">flow::net_flow::Sequence_number</a></div><div class="ttdoc">An internal net_flow sequence number identifying a piece of data.</div><div class="ttdef"><b>Definition:</b> <a href="seq__num_8hpp_source.html#l00125">seq_num.hpp:126</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Sequence__number_html_ab307e12c0cf8cefbe7fb1ec8588af2a8"><div class="ttname"><a href="classflow_1_1net__flow_1_1Sequence__number.html#ab307e12c0cf8cefbe7fb1ec8588af2a8">flow::net_flow::Sequence_number::seq_num_t</a></div><div class="ttdeci">uint64_t seq_num_t</div><div class="ttdoc">Raw sequence number type.</div><div class="ttdef"><b>Definition:</b> <a href="seq__num_8hpp_source.html#l00138">seq_num.hpp:138</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html">flow::net_flow::Server_socket</a></div><div class="ttdoc">A server socket able to listen on a single Flow port for incoming connections and return peer sockets...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00118">server_socket.hpp:126</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Socket__buffer_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Socket__buffer.html">flow::net_flow::Socket_buffer</a></div><div class="ttdoc">Internal net_flow class that implements a socket buffer, as used by Peer_socket for Send and Receive ...</div><div class="ttdef"><b>Definition:</b> <a href="socket__buffer_8hpp_source.html#l00095">socket_buffer.hpp:98</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Socket__buffer_html_a69a0c514df820c36e7109fb1fcf78522"><div class="ttname"><a href="classflow_1_1net__flow_1_1Socket__buffer.html#a69a0c514df820c36e7109fb1fcf78522">flow::net_flow::Socket_buffer::feed_bufs_copy</a></div><div class="ttdeci">size_t feed_bufs_copy(const Const_buffer_sequence &amp;data, size_t max_data_size)</div><div class="ttdoc">Feeds (adds to the back of the byte buffer) the contents of the byte stream composed of the bytes in ...</div><div class="ttdef"><b>Definition:</b> <a href="socket__buffer_8hpp_source.html#l00395">socket_buffer.hpp:395</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Socket__buffer_html_af60133c1d6825246b54f10f26810cd88"><div class="ttname"><a href="classflow_1_1net__flow_1_1Socket__buffer.html#af60133c1d6825246b54f10f26810cd88">flow::net_flow::Socket_buffer::consume_bufs_copy</a></div><div class="ttdeci">size_t consume_bufs_copy(const Mutable_buffer_sequence &amp;target_bufs)</div><div class="ttdoc">Consumes (removes from the front of the internal byte buffer and returns them to the caller) a byte s...</div><div class="ttdef"><b>Definition:</b> <a href="socket__buffer_8hpp_source.html#l00548">socket_buffer.hpp:548</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Linked__hash__map_html"><div class="ttname"><a href="classflow_1_1util_1_1Linked__hash__map.html">flow::util::Linked_hash_map&lt; Sequence_number, boost::shared_ptr&lt; Sent_packet &gt; &gt;</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Linked__hash__map_html_a1f09f98b4089a8c3ffd0b7f732923b44"><div class="ttname"><a href="classflow_1_1util_1_1Linked__hash__map.html#a1f09f98b4089a8c3ffd0b7f732923b44">flow::util::Linked_hash_map&lt; Sequence_number, boost::shared_ptr&lt; Sent_packet &gt; &gt;::iterator</a></div><div class="ttdeci">Iterator iterator</div><div class="ttdoc">For container compliance (hence the irregular capitalization): Iterator type.</div><div class="ttdef"><b>Definition:</b> <a href="linked__hash__map_8hpp_source.html#l00129">linked_hash_map.hpp:129</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Linked__hash__map_html_a2b5383264c89ac63cc8827b18063f2ca"><div class="ttname"><a href="classflow_1_1util_1_1Linked__hash__map.html#a2b5383264c89ac63cc8827b18063f2ca">flow::util::Linked_hash_map&lt; Sequence_number, boost::shared_ptr&lt; Sent_packet &gt; &gt;::const_iterator</a></div><div class="ttdeci">Const_iterator const_iterator</div><div class="ttdoc">For container compliance (hence the irregular capitalization): Const_iterator type.</div><div class="ttdef"><b>Definition:</b> <a href="linked__hash__map_8hpp_source.html#l00131">linked_hash_map.hpp:131</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Null__interface_html"><div class="ttname"><a href="classflow_1_1util_1_1Null__interface.html">flow::util::Null_interface</a></div><div class="ttdoc">An empty interface, consisting of nothing but a default virtual destructor, intended as a boiler-plat...</div><div class="ttdef"><b>Definition:</b> <a href="util_2util_8hpp_source.html#l00044">util.hpp:45</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Shared__ptr__alias__holder_html"><div class="ttname"><a href="classflow_1_1util_1_1Shared__ptr__alias__holder.html">flow::util::Shared_ptr_alias_holder</a></div><div class="ttdoc">Convenience class template that endows the given subclass T with nested aliases Ptr and Const_ptr ali...</div><div class="ttdef"><b>Definition:</b> <a href="shared__ptr__alias__holder_8hpp_source.html#l00119">shared_ptr_alias_holder.hpp:120</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Shared__ptr__alias__holder_html_aa4f1af88393042e60159a3a67f0accbc"><div class="ttname"><a href="classflow_1_1util_1_1Shared__ptr__alias__holder.html#aa4f1af88393042e60159a3a67f0accbc">flow::util::Shared_ptr_alias_holder&lt; boost::shared_ptr&lt; Server_socket &gt; &gt;::Ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; Server_socket &gt; Ptr</div><div class="ttdoc">Short-hand for ref-counted pointer to mutable values of type Target_type::element_type (a-la T*).</div><div class="ttdef"><b>Definition:</b> <a href="shared__ptr__alias__holder_8hpp_source.html#l00125">shared_ptr_alias_holder.hpp:125</a></div></div>
<div class="ttc" id="adetail_2net__flow__fwd_8hpp_html"><div class="ttname"><a href="detail_2net__flow__fwd_8hpp.html">net_flow_fwd.hpp</a></div></div>
<div class="ttc" id="aendpoint_8hpp_html"><div class="ttname"><a href="endpoint_8hpp.html">endpoint.hpp</a></div></div>
<div class="ttc" id="aerror_2error_8hpp_html_a636b2d30a8785df6e84646b568bce9b5"><div class="ttname"><a href="error_2error_8hpp.html#a636b2d30a8785df6e84646b568bce9b5">FLOW_ERROR_EXEC_AND_THROW_ON_ERROR</a></div><div class="ttdeci">#define FLOW_ERROR_EXEC_AND_THROW_ON_ERROR(ARG_ret_type, ARG_function_name,...)</div><div class="ttdoc">Narrow-use macro that implements the error code/exception semantics expected of most public-facing Fl...</div><div class="ttdef"><b>Definition:</b> <a href="error_2error_8hpp_source.html#l00363">error.hpp:363</a></div></div>
<div class="ttc" id="alinked__hash__map_8hpp_html"><div class="ttname"><a href="linked__hash__map_8hpp.html">linked_hash_map.hpp</a></div></div>
<div class="ttc" id="alow__lvl__io_8hpp_html"><div class="ttname"><a href="low__lvl__io_8hpp.html">low_lvl_io.hpp</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html"><div class="ttname"><a href="namespaceflow_1_1net__flow.html">flow::net_flow</a></div><div class="ttdoc">Flow module containing the API and implementation of the Flow network protocol, a TCP-inspired stream...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00024">node.cpp:25</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html_a079d8cd87a68d1c5f04c6bce71f0061d"><div class="ttname"><a href="namespaceflow_1_1net__flow.html#a079d8cd87a68d1c5f04c6bce71f0061d">flow::net_flow::flow_port_t</a></div><div class="ttdeci">uint16_t flow_port_t</div><div class="ttdoc">Logical Flow port type (analogous to a UDP/TCP port in spirit but in no way relevant to UDP/TCP).</div><div class="ttdef"><b>Definition:</b> <a href="net__flow__fwd_8hpp_source.html#l00054">net_flow_fwd.hpp:54</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html_ab9f537c84f77e9b8fa742fc5dc6d5693"><div class="ttname"><a href="namespaceflow_1_1net__flow.html#ab9f537c84f77e9b8fa742fc5dc6d5693">flow::net_flow::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Congestion_control_selector::Strategy_choice &amp;strategy_choice)</div><div class="ttdoc">Serializes a Peer_socket_options::Congestion_control_strategy_choice enum to a standard ostream – the...</div><div class="ttdef"><b>Definition:</b> <a href="cong__ctl_8cpp_source.html#l00146">cong_ctl.cpp:146</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_a5488415feb5570a6551892a7bdfeeec4"><div class="ttname"><a href="namespaceflow_1_1util.html#a5488415feb5570a6551892a7bdfeeec4">flow::util::chrono_duration_from_now_to_fine_time_pt</a></div><div class="ttdeci">Fine_time_pt chrono_duration_from_now_to_fine_time_pt(const boost::chrono::duration&lt; Rep, Period &gt; &amp;dur)</div><div class="ttdoc">Helper that takes a non-negative duration of arbitrary precision/period and converts it to Fine_durat...</div><div class="ttdef"><b>Definition:</b> <a href="util_2detail_2util_8hpp_source.html#l00042">util.hpp:42</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_a5d2247b715da63e4b960909561b90ae7"><div class="ttname"><a href="namespaceflow_1_1util.html#a5d2247b715da63e4b960909561b90ae7">flow::util::Lock_guard</a></div><div class="ttdeci">boost::unique_lock&lt; Mutex &gt; Lock_guard</div><div class="ttdoc">Short-hand for advanced-capability RAII lock guard for any mutex, ensuring exclusive ownership of tha...</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00265">util_fwd.hpp:265</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_a9c7a5df07c2e86c788de9e6bbaee77d5"><div class="ttname"><a href="namespaceflow_1_1util.html#a9c7a5df07c2e86c788de9e6bbaee77d5">flow::util::Mutex_recursive</a></div><div class="ttdeci">boost::recursive_mutex Mutex_recursive</div><div class="ttdoc">Short-hand for reentrant, exclusive mutex.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00218">util_fwd.hpp:218</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_aa0d10f5a906b3229f48979aa43e9ff7e"><div class="ttname"><a href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">flow::util::Scheduled_task_handle</a></div><div class="ttdeci">boost::shared_ptr&lt; Scheduled_task_handle_state &gt; Scheduled_task_handle</div><div class="ttdoc">Black-box type that represents a handle to a scheduled task as scheduled by schedule_task_at() or sch...</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__fwd_8hpp_source.html#l00045">sched_task_fwd.hpp:45</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_ac3e89a8a271b0ddc76ac2a0ce488dea4"><div class="ttname"><a href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">flow::util::Task_engine</a></div><div class="ttdeci">boost::asio::io_context Task_engine</div><div class="ttdoc">Short-hand for boost.asio event service, the central class of boost.asio.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00135">util_fwd.hpp:135</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_add6ade273326f27eaf9bfd170a909626"><div class="ttname"><a href="namespaceflow_1_1util.html#add6ade273326f27eaf9bfd170a909626">flow::util::Mutex_non_recursive</a></div><div class="ttdeci">boost::mutex Mutex_non_recursive</div><div class="ttdoc">Short-hand for non-reentrant, exclusive mutex. (&quot;Reentrant&quot; = one can lock an already-locked-in-that-...</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00215">util_fwd.hpp:215</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_ae7416d64d2989051104bb396e28e15e6"><div class="ttname"><a href="namespaceflow_1_1util.html#ae7416d64d2989051104bb396e28e15e6">flow::util::Timer</a></div><div class="ttdeci">boost::asio::basic_waitable_timer&lt; Fine_clock &gt; Timer</div><div class="ttdoc">boost.asio timer.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00202">util_fwd.hpp:202</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_af09888b3a8feaff209b6625e493bc338"><div class="ttname"><a href="namespaceflow_1_1util.html#af09888b3a8feaff209b6625e493bc338">flow::util::Blob</a></div><div class="ttdeci">Blob_with_log_context&lt;&gt; Blob</div><div class="ttdoc">A concrete Blob_with_log_context that compile-time-disables Basic_blob::share() and the sharing API d...</div><div class="ttdef"><b>Definition:</b> <a href="blob__fwd_8hpp_source.html#l00060">blob_fwd.hpp:60</a></div></div>
<div class="ttc" id="anamespaceflow_html_a29eaaa9d0fac4ce87d8b969222dbed09"><div class="ttname"><a href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">flow::Error_code</a></div><div class="ttdeci">boost::system::error_code Error_code</div><div class="ttdoc">Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00508">common.hpp:508</a></div></div>
<div class="ttc" id="anamespaceflow_html_a48799f1263cdeedec125be51a3db2b79"><div class="ttname"><a href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">flow::Fine_duration</a></div><div class="ttdeci">Fine_clock::duration Fine_duration</div><div class="ttdoc">A high-res time duration as computed from two Fine_time_pts.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00416">common.hpp:416</a></div></div>
<div class="ttc" id="anamespaceflow_html_a9d9cc2eeb10d398cff5591d446b763b8"><div class="ttname"><a href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">flow::Fine_time_pt</a></div><div class="ttdeci">Fine_clock::time_point Fine_time_pt</div><div class="ttdoc">A high-res time point as returned by Fine_clock::now() and suitable for precise time math in general.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00413">common.hpp:413</a></div></div>
<div class="ttc" id="anet__flow_2error_2error_8hpp_html"><div class="ttname"><a href="net__flow_2error_2error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="anet__flow__fwd_8hpp_html"><div class="ttname"><a href="net__flow__fwd_8hpp.html">net_flow_fwd.hpp</a></div></div>
<div class="ttc" id="aoptions_8hpp_html"><div class="ttname"><a href="options_8hpp.html">options.hpp</a></div></div>
<div class="ttc" id="asched__task__fwd_8hpp_html"><div class="ttname"><a href="sched__task__fwd_8hpp.html">sched_task_fwd.hpp</a></div></div>
<div class="ttc" id="aserver__socket_8hpp_html"><div class="ttname"><a href="server__socket_8hpp.html">server_socket.hpp</a></div></div>
<div class="ttc" id="ashared__ptr__alias__holder_8hpp_html"><div class="ttname"><a href="shared__ptr__alias__holder_8hpp.html">shared_ptr_alias_holder.hpp</a></div></div>
<div class="ttc" id="asocket__buffer_8hpp_html"><div class="ttname"><a href="socket__buffer_8hpp.html">socket_buffer.hpp</a></div></div>
<div class="ttc" id="asocket__stats_8hpp_html"><div class="ttname"><a href="socket__stats_8hpp.html">socket_stats.hpp</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html">flow::net_flow::Peer_socket::Individual_ack</a></div><div class="ttdoc">Metadata describing the data sent in the acknowledgment of an individual received packet.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02379">peer_socket.hpp:2381</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack_html_a0af3081c75e1c552807ecc7af416efba"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a0af3081c75e1c552807ecc7af416efba">flow::net_flow::Peer_socket::Individual_ack::m_data_size</a></div><div class="ttdeci">const size_t m_data_size</div><div class="ttdoc">Number of bytes in the packet's user data.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02406">peer_socket.hpp:2406</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack_html_a209d79e058d103c84fc10be84d492a8b"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a209d79e058d103c84fc10be84d492a8b">flow::net_flow::Peer_socket::Individual_ack::Const_ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; const Individual_ack &gt; Const_ptr</div><div class="ttdoc">Short-hand for ref-counted pointer to immutable objects of this class.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02388">peer_socket.hpp:2388</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack_html_a29080d01ac5bc0d51ad407587c6721ab"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a29080d01ac5bc0d51ad407587c6721ab">flow::net_flow::Peer_socket::Individual_ack::m_rexmit_id</a></div><div class="ttdeci">const unsigned int m_rexmit_id</div><div class="ttdoc">Retransmit counter of the packet (as reported by sender).</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02400">peer_socket.hpp:2400</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack_html_a8a237605b83d8a0d1b175395a83ad768"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#a8a237605b83d8a0d1b175395a83ad768">flow::net_flow::Peer_socket::Individual_ack::m_seq_num</a></div><div class="ttdeci">const Sequence_number m_seq_num</div><div class="ttdoc">Sequence number of first datum in packet.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02393">peer_socket.hpp:2393</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack_html_ad32d17739f7965eeeedfbeae5bfbc1a3"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#ad32d17739f7965eeeedfbeae5bfbc1a3">flow::net_flow::Peer_socket::Individual_ack::Ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; Individual_ack &gt; Ptr</div><div class="ttdoc">Short-hand for ref-counted pointer to mutable objects of this class.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02385">peer_socket.hpp:2385</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack_html_ad6e1407a2a3fc95e568b00f31e423b25"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#ad6e1407a2a3fc95e568b00f31e423b25">flow::net_flow::Peer_socket::Individual_ack::m_received_when</a></div><div class="ttdeci">const Fine_time_pt m_received_when</div><div class="ttdoc">When was it received? Used for supplying delay before acknowledging (for other side's RTT calculation...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02403">peer_socket.hpp:2403</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack_html_af6ffacd3b12b70bf06b70bc8645315c5"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Individual__ack.html#af6ffacd3b12b70bf06b70bc8645315c5">flow::net_flow::Peer_socket::Individual_ack::m_nc</a></div><div class="ttdeci">util::Noncopyable m_nc</div><div class="ttdoc">Make us noncopyable without breaking aggregateness (direct-init).</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02409">peer_socket.hpp:2409</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Received__packet_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html">flow::net_flow::Peer_socket::Received_packet</a></div><div class="ttdoc">Metadata (and data, if retransmission is on) for a packet that has been received (and,...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02334">peer_socket.hpp:2338</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Received__packet_html_a7d0760b1dead081bdcf775fbca7f708b"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html#a7d0760b1dead081bdcf775fbca7f708b">flow::net_flow::Peer_socket::Received_packet::m_size</a></div><div class="ttdeci">const size_t m_size</div><div class="ttdoc">Number of bytes in the Data_packet::m_data field of that packet.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02342">peer_socket.hpp:2342</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Received__packet_html_a9f0809d5dd7272e31f4111ee2be97330"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html#a9f0809d5dd7272e31f4111ee2be97330">flow::net_flow::Peer_socket::Received_packet::Received_packet</a></div><div class="ttdeci">Received_packet(log::Logger *logger_ptr, size_t size, util::Blob *src_data)</div><div class="ttdoc">Constructs object by storing size of data and, if so instructed, the data themselves.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00441">peer_socket.cpp:441</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Received__packet_html_ac3e88e37e53d2572f89c599e520e3e2a"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Received__packet.html#ac3e88e37e53d2572f89c599e520e3e2a">flow::net_flow::Peer_socket::Received_packet::m_data</a></div><div class="ttdeci">util::Blob m_data</div><div class="ttdoc">Byte sequence equal to that of Data_packet::m_data of the packet.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02350">peer_socket.hpp:2350</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html">flow::net_flow::Peer_socket::Sent_packet::Sent_when</a></div><div class="ttdoc">Data store to keep timing related info when a packet is sent out.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02279">peer_socket.hpp:2280</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when_html_a5265c3824ad25d1de4f888fa811dd4e6"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html#a5265c3824ad25d1de4f888fa811dd4e6">flow::net_flow::Peer_socket::Sent_packet::Sent_when::m_order_num</a></div><div class="ttdeci">const order_num_t m_order_num</div><div class="ttdoc">Order number of the packet.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02294">peer_socket.hpp:2294</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when_html_abc5bf2e627dad5d2dcfb0324853b37f7"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html#abc5bf2e627dad5d2dcfb0324853b37f7">flow::net_flow::Peer_socket::Sent_packet::Sent_when::m_sent_cwnd_bytes</a></div><div class="ttdeci">size_t m_sent_cwnd_bytes</div><div class="ttdoc">The congestion window size (in bytes) that is used when the packet is sent out.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02324">peer_socket.hpp:2324</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when_html_ad513e58f4eb611c3a91d96df26f53f2c"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_1_1Sent__when.html#ad513e58f4eb611c3a91d96df26f53f2c">flow::net_flow::Peer_socket::Sent_packet::Sent_when::m_sent_time</a></div><div class="ttdeci">Fine_time_pt m_sent_time</div><div class="ttdoc">The timestamp when the packet is sent out.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02306">peer_socket.hpp:2306</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html">flow::net_flow::Peer_socket::Sent_packet</a></div><div class="ttdoc">Metadata (and data, if retransmission is on) for a packet that has been sent one (if retransmission i...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02174">peer_socket.hpp:2178</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_html_a28eb52fe9520497d02f6c0cd51a5fa9b"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a28eb52fe9520497d02f6c0cd51a5fa9b">flow::net_flow::Peer_socket::Sent_packet::Sent_packet</a></div><div class="ttdeci">Sent_packet(bool rexmit_on, boost::shared_ptr&lt; Data_packet &gt; packet, const Sent_when &amp;sent_when)</div><div class="ttdoc">Constructs object with the given values and m_acks_after_me at zero.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l00430">peer_socket.cpp:430</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_html_a3acccd2fcd0f4a0c5f7f0c2d6ad31c2e"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a3acccd2fcd0f4a0c5f7f0c2d6ad31c2e">flow::net_flow::Peer_socket::Sent_packet::m_sent_when</a></div><div class="ttdeci">std::vector&lt; Sent_when &gt; m_sent_when</div><div class="ttdoc">Time stamps, order numbers, and other info at the times when the different attempts (including origin...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02217">peer_socket.hpp:2217</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_html_a5b5762a1effba90f631c06ad76f9774b"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a5b5762a1effba90f631c06ad76f9774b">flow::net_flow::Peer_socket::Sent_packet::m_size</a></div><div class="ttdeci">const size_t m_size</div><div class="ttdoc">Number of bytes in the Data_packet::m_data field of the sent packet.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02195">peer_socket.hpp:2195</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_html_a704afa0007b8354ad78acad64d029ecf"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a704afa0007b8354ad78acad64d029ecf">flow::net_flow::Peer_socket::Sent_packet::m_packet</a></div><div class="ttdeci">const boost::shared_ptr&lt; Data_packet &gt; m_packet</div><div class="ttdoc">If retransmission is on, this is the DATA packet itself that was sent; otherwise null.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02251">peer_socket.hpp:2251</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_html_a7913f73b4e2f164ca51ebb505b63c1f2"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#a7913f73b4e2f164ca51ebb505b63c1f2">flow::net_flow::Peer_socket::Sent_packet::ack_count_t</a></div><div class="ttdeci">uint16_t ack_count_t</div><div class="ttdoc">Type used for m_acks_after_me.</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02190">peer_socket.hpp:2190</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet_html_affeb974bc03966744adfcda0366a50aa"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket_1_1Sent__packet.html#affeb974bc03966744adfcda0366a50aa">flow::net_flow::Peer_socket::Sent_packet::m_acks_after_me</a></div><div class="ttdeci">ack_count_t m_acks_after_me</div><div class="ttdoc">The number of times any packet with m_sent_when.back().m_order_num &gt; this-&gt;m_sent_when....</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l02236">peer_socket.hpp:2236</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket__info_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket__info.html">flow::net_flow::Peer_socket_info</a></div><div class="ttdoc">A data store that keeps stats about the a Peer_socket connection.</div><div class="ttdef"><b>Definition:</b> <a href="info_8hpp_source.html#l00455">info.hpp:456</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket__options_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket__options.html">flow::net_flow::Peer_socket_options</a></div><div class="ttdoc">A set of low-level options affecting a single Peer_socket.</div><div class="ttdef"><b>Definition:</b> <a href="options_8hpp_source.html#l00035">options.hpp:36</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Remote__endpoint_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Remote__endpoint.html">flow::net_flow::Remote_endpoint</a></div><div class="ttdoc">Represents the remote endpoint of a Flow-protocol connection; identifies the UDP endpoint of the remo...</div><div class="ttdef"><b>Definition:</b> <a href="endpoint_8hpp_source.html#l00092">endpoint.hpp:93</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Send__pacing__data_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Send__pacing__data.html">flow::net_flow::Send_pacing_data</a></div><div class="ttdoc">The current outgoing packet pacing state, including queue of low-level packets to be sent,...</div><div class="ttdef"><b>Definition:</b> <a href="low__lvl__io_8hpp_source.html#l00176">low_lvl_io.hpp:178</a></div></div>
<div class="ttc" id="astructflow_1_1util_1_1Noncopyable_html"><div class="ttname"><a href="structflow_1_1util_1_1Noncopyable.html">flow::util::Noncopyable</a></div><div class="ttdoc">Useful as a no-unique-address private member to make a type noncopyable while keeping that type an ag...</div><div class="ttdef"><b>Definition:</b> <a href="util_2util_8hpp_source.html#l00073">util.hpp:74</a></div></div>
<div class="ttc" id="autil_2util_8hpp_html"><div class="ttname"><a href="util_2util_8hpp.html">util.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
